Package org.odpi.openmetadata.accessservices.assetowner.server.spring

Class AssetOwnerResource

java.lang.Object
org.odpi.openmetadata.accessservices.assetowner.server.spring.AssetOwnerResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/asset-owner/users/{userId}") public class AssetOwnerResource extends Object
AssetOwnerResource provides the generic server-side interface for the Asset Owner Open Metadata Access Service (OMAS). There are other resources that provide specialized methods for specific types of Asset.

  • Constructor Details

    • AssetOwnerResource

      public AssetOwnerResource()
      Default constructor

  • Method Details

    • getServiceDescription

      @GetMapping(path="/description") public RegisteredOMAGServiceResponse getServiceDescription(@PathVariable String serverName, @PathVariable String userId)
      Return the description of this service.
      Parameters:
      serverName - name of the server to route the request to
      userId - identifier of calling user
      Returns:
      service description or InvalidParameterException one of the parameters is null or invalid or UserNotAuthorizedException user not authorized to issue this request or PropertyServerException problem retrieving the discovery engine definition.

    • getTypesOfAsset

      @GetMapping(path="/assets/sub-types") public NameListResponse getTypesOfAsset(@PathVariable String serverName, @PathVariable String userId)
      Return the asset subtype names.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      Returns:
      list of type names that are subtypes of asset or throws InvalidParameterException full path or userId is null or throws PropertyServerException problem accessing property server or throws UserNotAuthorizedException security access problem.

    • getTypesOfAssetDescriptions

      @GetMapping(path="/assets/sub-types/descriptions") public StringMapResponse getTypesOfAssetDescriptions(@PathVariable String serverName, @PathVariable String userId)
      Return the asset subtype names mapped to their descriptions.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      Returns:
      list of type names that are subtypes of asset or throws InvalidParameterException full path or userId is null or throws PropertyServerException problem accessing property server or throws UserNotAuthorizedException security access problem.

    • addAssetToCatalog

      @PostMapping(path="/assets/{typeName}") public GUIDResponse addAssetToCatalog(@PathVariable String serverName, @PathVariable String userId, @PathVariable String typeName, @RequestBody AssetProperties requestBody)
      Add a simple asset description to the catalog.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user (assumed to be the owner)
      typeName - specific type of the asset - this must match a defined subtype
      requestBody - other properties for asset
      Returns:
      unique identifier (guid) of the asset or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addAssetToCatalogUsingTemplate

      @PostMapping(path="/assets/from-template/{templateGUID}") public GUIDResponse addAssetToCatalogUsingTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String templateGUID, @RequestBody TemplateProperties requestBody)
      Create a new metadata element to represent an asset using an existing asset as a template.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      requestBody - properties that override the template
      Returns:
      unique identifier (guid) of the asset or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateAsset

      @PostMapping(path="/assets/{assetGUID}/update") public VoidResponse updateAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestParam boolean isMergeUpdate, @RequestBody AssetProperties requestBody)
      Update a simple asset description to the catalog.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user (assumed to be the owner)
      assetGUID - unique identifier of the asset
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      requestBody - other properties for asset
      Returns:
      unique identifier (guid) of the asset or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • setupRelatedAsset

      @PostMapping(path="/assets/relationships/{relationshipTypeName}/from-asset/{fromAssetGUID}/to-asset/{toAssetGUID}") public GUIDResponse setupRelatedAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipTypeName, @PathVariable String fromAssetGUID, @PathVariable String toAssetGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Link two asset together. Use information from the relationship type definition to ensure the fromAssetGUID and toAssetGUID are the right way around.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      relationshipTypeName - type name of relationship to create
      fromAssetGUID - unique identifier of the asset at end 1 of the relationship
      toAssetGUID - unique identifier of the asset at end 2 of the relationship
      requestBody - unique identifier for this relationship
      Returns:
      unique identifier of the relationship 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)

    • getAssetRelationship

      @PostMapping(path="/assets/relationships/{relationshipTypeName}/from-asset/{fromAssetGUID}/to-asset/{toAssetGUID}/retrieve") public RelationshipElementResponse getAssetRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipTypeName, @PathVariable String fromAssetGUID, @PathVariable String toAssetGUID, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the relationship between two elements.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      relationshipTypeName - type name of relationship to create
      fromAssetGUID - unique identifier of the asset at end 1 of the relationship
      toAssetGUID - unique identifier of the asset at end 2 of the relationship
      requestBody - optional date for effective time of the query. Null means any effective time
      Returns:
      unique identifier and properties of the relationship 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)

    • updateAssetRelationship

      @PostMapping(path="/assets/relationships/{relationshipTypeName}/{relationshipGUID}/update") public VoidResponse updateAssetRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipTypeName, @PathVariable String relationshipGUID, @RequestParam boolean isMergeUpdate, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Update relationship between two elements.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      relationshipTypeName - type name of relationship to update
      relationshipGUID - unique identifier of the relationship
      isMergeUpdate - should the new properties be merged with the existing properties, or replace them entirely
      requestBody - description and/or purpose of the relationship
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • clearAssetRelationship

      @PostMapping(path="/assets/relationships/{relationshipTypeName}/{relationshipGUID}/remove") public VoidResponse clearAssetRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipTypeName, @PathVariable String relationshipGUID, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Remove the relationship between two elements.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      relationshipTypeName - type name of relationship to delete
      relationshipGUID - unique identifier of the relationship
      requestBody - external source ids
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getRelatedAssetsAtEnd2

      @PostMapping(path="/assets/relationships/{relationshipTypeName}/from-asset/{fromAssetGUID}/retrieve/end2") public RelationshipElementsResponse getRelatedAssetsAtEnd2(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipTypeName, @PathVariable String fromAssetGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the requested relationships linked from a specific element at end 2.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      relationshipTypeName - type name of relationship to delete
      fromAssetGUID - unique identifier of the asset at end 1 of the relationship
      startFrom - start position for results
      pageSize - maximum number of results
      requestBody - effective time
      Returns:
      unique identifier and properties of the relationships 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)

    • getRelatedAssetsAtEnd1

      @PostMapping(path="/assets/relationships/{relationshipTypeName}/to-asset/{toAssetGUID}/retrieve/end1") public RelationshipElementsResponse getRelatedAssetsAtEnd1(@PathVariable String serverName, @PathVariable String userId, @PathVariable String relationshipTypeName, @PathVariable String toAssetGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody EffectiveTimeQueryRequestBody requestBody)
      Retrieve the relationships linked from a specific element at end 2 of the relationship.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      relationshipTypeName - type name of relationship to delete
      toAssetGUID - unique identifier of the asset at end 2 of the relationship
      startFrom - start position for results
      pageSize - maximum number of results
      requestBody - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Returns:
      unique identifier and properties of the relationships 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)

    • addCombinedSchemaToAsset

      @PostMapping(path="/assets/{assetGUID}/schemas/top-level-schema-type-with-attributes") @Deprecated public GUIDResponse addCombinedSchemaToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody CombinedSchemaRequestBody schemaInformation)
      Deprecated.
      Stores the supplied schema details in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted. If more attributes need to be added in addition to the ones supplied then this can be done with addSchemaAttributesToSchemaType().
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaInformation - schema type to create and attach directly to the asset.
      Returns:
      guid of the schema type or InvalidParameterException full path or userId is null, or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addComplexSchemaToAsset

      @PostMapping(path="/assets/{assetGUID}/schemas/with-attributes") public GUIDResponse addComplexSchemaToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody CombinedSchemaRequestBody schemaInformation)
      Stores the supplied schema details in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted. If more attributes need to be added in addition to the ones supplied then this can be done with addSchemaAttributesToSchemaType().
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaInformation - schema type to create and attach directly to the asset.
      Returns:
      guid of the schema type or InvalidParameterException full path or userId is null, or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSchemaTypeToAsset

      @PostMapping(path="/assets/{assetGUID}/schemas") public GUIDResponse addSchemaTypeToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody SchemaTypeProperties schemaType)
      Stores the supplied schema type in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaType - schema type to create and attach directly to the asset.
      Returns:
      guid of the new schema type or InvalidParameterException full path or userId is null, or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • attachSchemaTypeToAsset

      @PostMapping(path="/assets/{assetGUID}/schemas/{schemaTypeGUID}/attach") public VoidResponse attachSchemaTypeToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Links the supplied schema type directly to the asset. If this schema is either not found, or already attached to an asset, then an error occurs. If another schema is currently attached to the asset, it is unlinked and deleted.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      schemaTypeGUID - unique identifier of the schema type to attach
      requestBody - null
      Returns:
      void or InvalidParameterException full path or userId or one of the GUIDs is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • detachSchemaTypeFromAsset

      @PostMapping(path="/assets/{assetGUID}/schemas/detach") public GUIDResponse detachSchemaTypeFromAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Unlinks the schema from the asset but does not delete it. This means it can be reattached to a different asset.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      requestBody - null
      Returns:
      guid of the schema type or InvalidParameterException full path or userId or one of the GUIDs is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • deleteAssetSchemaType

      @PostMapping(path="/assets/{assetGUID}/schemas/delete") public VoidResponse deleteAssetSchemaType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Detaches and deletes an asset's schema.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      requestBody - null
      Returns:
      void or InvalidParameterException full path or userId is null, or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • createSchemaType

      @PostMapping(path="/schema-types") public GUIDResponse createSchemaType(@PathVariable String serverName, @PathVariable String userId, @RequestParam(required=false,defaultValue="null") String anchorGUID, @RequestBody SchemaTypeProperties requestBody)
      Create a new metadata element to represent a schema type.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      anchorGUID - unique identifier of the intended anchor of the schema type
      requestBody - properties about the schema type to store
      Returns:
      unique identifier of the new schema type InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • createSchemaTypeFromTemplate

      @PostMapping(path="/schema-types/from-template/{templateGUID}") public GUIDResponse createSchemaTypeFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String templateGUID, @RequestBody TemplateRequestBody requestBody)
      Create a new metadata element to represent a schema type using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      templateGUID - unique identifier of the metadata element to copy
      requestBody - properties that override the template
      Returns:
      unique identifier of the new schema type InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateSchemaType

      @PostMapping(path="/schema-types/{schemaTypeGUID}") public VoidResponse updateSchemaType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaTypeGUID, @RequestParam boolean isMergeUpdate, @RequestBody SchemaTypeProperties requestBody)
      Update the metadata element representing a schema type.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaTypeGUID - unique identifier of the metadata element to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      requestBody - new properties for the metadata element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • setupSchemaTypeParent

      @PostMapping(path="/parents/{parentElementGUID}/{parentElementTypeName}/schema-types/{schemaTypeGUID}") public VoidResponse setupSchemaTypeParent(@PathVariable String serverName, @PathVariable String userId, @PathVariable String parentElementGUID, @PathVariable String parentElementTypeName, @PathVariable String schemaTypeGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Connect a schema type to a data asset, process or port.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaTypeGUID - unique identifier of the schema type to connect
      parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
      parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • clearSchemaTypeParent

      @PostMapping(path="/parents/{parentElementGUID}/{parentElementTypeName}/schema-types/{schemaTypeGUID}/remove") public VoidResponse clearSchemaTypeParent(@PathVariable String serverName, @PathVariable String userId, @PathVariable String parentElementGUID, @PathVariable String parentElementTypeName, @PathVariable String schemaTypeGUID, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Remove the relationship between a schema type and its parent data asset, process or port.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaTypeGUID - unique identifier of the schema type to connect
      parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
      parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • setupSchemaElementRelationship

      @PostMapping(path="/schema-elements/{endOneGUID}/relationships/{relationshipTypeName}/schema-elements/{endTwoGUID}") public VoidResponse setupSchemaElementRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String endOneGUID, @PathVariable String relationshipTypeName, @PathVariable String endTwoGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Create a relationship between two schema elements. The name of the desired relationship, and any properties (including effectivity dates) are passed on the API.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      endOneGUID - unique identifier of the schema element at end one of the relationship
      endTwoGUID - unique identifier of the schema element at end two of the relationship
      relationshipTypeName - type of the relationship to create
      requestBody - relationship properties
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • clearSchemaElementRelationship

      @PostMapping(path="/schema-elements/{endOneGUID}/relationships/{relationshipTypeName}/schema-elements/{endTwoGUID}/remove") public VoidResponse clearSchemaElementRelationship(@PathVariable String serverName, @PathVariable String userId, @PathVariable String endOneGUID, @PathVariable String relationshipTypeName, @PathVariable String endTwoGUID, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Remove a relationship between two schema elements. The name of the desired relationship is passed on the API.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      endOneGUID - unique identifier of the schema element at end one of the relationship
      endTwoGUID - unique identifier of the schema element at end two of the relationship
      relationshipTypeName - type of the relationship to delete
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeSchemaType

      @PostMapping(path="/schema-types/{schemaTypeGUID}/remove") public VoidResponse removeSchemaType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaTypeGUID, @RequestBody(required=false) UpdateRequestBody requestBody)
      Remove the metadata element representing a schema type.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaTypeGUID - unique identifier of the metadata element to remove
      requestBody - unique identifier/name of software server capability representing the caller and external identifier of element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findSchemaType

      @PostMapping(path="/schema-types/by-search-string") public SchemaTypeElementsResponse findSchemaType(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
      Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties plus external identifiers
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getSchemaTypeForElement

      @PostMapping(path="/parents/{parentElementTypeName}/{parentElementGUID}/schema-types/retrieve") public SchemaTypeElementResponse getSchemaTypeForElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String parentElementGUID, @PathVariable String parentElementTypeName, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Return the schema type associated with a specific open metadata element (data asset, process or port).
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      parentElementGUID - unique identifier of the open metadata element that this schema type is to be connected to
      parentElementTypeName - unique type name of the open metadata element that this schema type is to be connected to
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      metadata element describing the schema type associated with the requested parent element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getSchemaTypeByName

      @PostMapping(path="/schema-types/by-name") public SchemaTypeElementsResponse getSchemaTypeByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
      Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - name to search for plus identifiers
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getSchemaTypeByGUID

      @PostMapping(path="/schema-types/{schemaTypeGUID}/retrieve") public SchemaTypeElementResponse getSchemaTypeByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaTypeGUID, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the schema type metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaTypeGUID - unique identifier of the requested metadata element
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      requested metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getSchemaTypeParent

      @PostMapping(path="/parents/schema-types/{schemaTypeGUID}/retrieve") public ElementHeaderResponse getSchemaTypeParent(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaTypeGUID, @RequestBody(required=false) EffectiveTimeQueryRequestBody requestBody)
      Retrieve the header of the metadata element connected to a schema type.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaTypeGUID - unique identifier of the requested metadata element
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      header for parent element (data asset, process, port) or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • addSchemaAttributes

      @PostMapping(path="/assets/{assetGUID}/schemas/{parentGUID}/schema-attributes/list") public VoidResponse addSchemaAttributes(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String parentGUID, @RequestBody List<SchemaAttributeProperties> schemaAttributes)
      Adds attributes to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      parentGUID - unique identifier of the schema element to anchor these attributes to.
      schemaAttributes - list of schema attribute objects.
      Returns:
      list of unique identifiers for the new schema attributes returned in the same order as the supplied attribute or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSchemaAttribute

      @PostMapping(path="/assets/{assetGUID}/schemas/{parentGUID}/schema-attributes") public GUIDResponse addSchemaAttribute(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String parentGUID, @RequestBody SchemaAttributeProperties schemaAttribute)
      Adds the attribute to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema. The GUID returned can be used to add nested attributes.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that the schema is to be attached to
      parentGUID - unique identifier of the schema element to anchor these attributes to.
      schemaAttribute - schema attribute object.
      Returns:
      list of unique identifiers for the new schema attributes returned in the same order as the supplied attribute or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • createSchemaAttributeFromTemplate

      @PostMapping(path="/schema-elements/{schemaElementGUID}/schema-attributes/from-template/{templateGUID}") public GUIDResponse createSchemaAttributeFromTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaElementGUID, @PathVariable String templateGUID, @RequestBody TemplateRequestBody requestBody)
      Create a new metadata element to represent a schema attribute using an existing metadata element as a template.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the schema attribute is connected to
      templateGUID - unique identifier of the metadata element to copy
      requestBody - properties that override the template
      Returns:
      unique identifier of the new metadata element for the schema attribute or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • updateSchemaAttribute

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}") public VoidResponse updateSchemaAttribute(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaAttributeGUID, @RequestParam boolean isMergeUpdate, @RequestBody SchemaAttributeProperties requestBody)
      Update the properties of the metadata element representing a schema attribute.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaAttributeGUID - unique identifier of the schema attribute to update
      isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
      requestBody - new properties for the schema attribute
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • setSchemaElementAsCalculatedValue

      @PostMapping(path="/schema-elements/{schemaElementGUID}/is-calculated-value") public VoidResponse setSchemaElementAsCalculatedValue(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaElementGUID, @RequestBody CalculatedValueClassificationRequestBody requestBody)
      Classify the schema type (or attribute if type is embedded) to indicate that it is a calculated value.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaElementGUID - unique identifier of the metadata element to update
      requestBody - unique identifier/name of software server capability representing the caller and external identifier of element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • clearSchemaElementAsCalculatedValue

      @PostMapping(path="/schema-elements/{schemaElementGUID}/is-calculated-value/remove") public VoidResponse clearSchemaElementAsCalculatedValue(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaElementGUID, @RequestBody UpdateRequestBody requestBody)
      Remove the calculated value designation from the schema element.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaElementGUID - unique identifier of the metadata element to update
      requestBody - unique identifier/name of software server capability representing the caller and external identifier of element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • removeSchemaAttribute

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/remove") public VoidResponse removeSchemaAttribute(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaAttributeGUID, @RequestBody UpdateRequestBody requestBody)
      Remove the metadata element representing a schema attribute.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaAttributeGUID - unique identifier of the metadata element to remove
      requestBody - unique identifier/name of software server capability representing the caller and external identifier of element
      Returns:
      void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • findSchemaAttributes

      @PostMapping(path="/schema-attributes/by-search-string") public SchemaAttributesResponse findSchemaAttributes(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
      Retrieve the list of schema attribute metadata elements that contain the search string. The search string is treated as a regular expression.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - string to find in the properties plus external identifiers
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getNestedAttributes

      @PostMapping(path="/schema-elements/{parentSchemaElementGUID}/schema-attributes/retrieve") public SchemaAttributesResponse getNestedAttributes(@PathVariable String serverName, @PathVariable String userId, @PathVariable String parentSchemaElementGUID, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody EffectiveTimeQueryRequestBody requestBody)
      Retrieve the list of schema attributes associated with a schema element.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      parentSchemaElementGUID - unique identifier of the schema element of interest
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      list of associated metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getSchemaAttributesByName

      @PostMapping(path="/schema-attributes/by-name") public SchemaAttributesResponse getSchemaAttributesByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
      Retrieve the list of schema attribute metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      list of matching metadata elements or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • getSchemaAttributeByGUID

      @PostMapping(path="/schema-attributes/{schemaAttributeGUID}/retrieve") public SchemaAttributeResponse getSchemaAttributeByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String schemaAttributeGUID, @RequestBody EffectiveTimeQueryRequestBody requestBody)
      Retrieve the schema attribute metadata element with the supplied unique identifier.
      Parameters:
      serverName - name of the server to route the request to
      userId - calling user
      schemaAttributeGUID - unique identifier of the requested metadata element
      requestBody - unique identifier/name of software server capability representing the caller
      Returns:
      matching metadata element or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)

    • addConnectionToAsset

      @PostMapping(path="/assets/{assetGUID}/connection") public VoidResponse addConnectionToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody OCFConnectionRequestBody requestBody)
      Adds a connection to an asset. Assets can have multiple connections attached.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset to attach the connection to
      requestBody - request body including a summary and connection object. If the connection is already stored (matching guid) then the existing connection is used.
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSemanticAssignment

      @PostMapping(path="/assets/{assetGUID}/meanings/{glossaryTermGUID}") public VoidResponse addSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String glossaryTermGUID, @RequestBody(required=false) SemanticAssignmentProperties requestBody)
      Create a simple relationship between a glossary term and an Asset description.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that is being described
      glossaryTermGUID - unique identifier of the glossary term
      requestBody - null request body to satisfy POST request.
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSemanticAssignment

      @PostMapping(path="/assets/{assetGUID}/attachments/{assetElementGUID}/meanings/{glossaryTermGUID}") public VoidResponse addSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String glossaryTermGUID, @PathVariable String assetElementGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset that is being described
      glossaryTermGUID - unique identifier of the glossary term
      assetElementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - null request body to satisfy POST request.
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeSemanticAssignment

      @PostMapping(path="/assets/{assetGUID}/meanings/{glossaryTermGUID}/delete") public VoidResponse removeSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String glossaryTermGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of asset
      glossaryTermGUID - unique identifier of the glossary term
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeSemanticAssignment

      @PostMapping(path="/assets/{assetGUID}/attachments/{assetElementGUID}/meanings/{glossaryTermGUID}/delete") public VoidResponse removeSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String glossaryTermGUID, @PathVariable String assetElementGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of asset
      glossaryTermGUID - unique identifier of the glossary term
      assetElementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - null request body
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addAssetOrigin

      @PostMapping(path="/assets/{assetGUID}/origin") public VoidResponse addAssetOrigin(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody OriginRequestBody requestBody)
      Set up the labels that classify an asset's origin.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of asset
      requestBody - Descriptive labels describing origin of the asset
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeAssetOrigin

      @PostMapping(path="/assets/{assetGUID}/origin/delete") public VoidResponse removeAssetOrigin(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove the asset origin classification to an asset.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of asset
      requestBody - null request body
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • publishAsset

      @PostMapping(path="/assets/{assetGUID}/publish") public VoidResponse publishAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Update the zones for a specific asset to the zone list specified in the publishZones.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier for the asset to update
      requestBody - null request body
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • withdrawAsset

      @PostMapping(path="/assets/{assetGUID}/withdraw") public VoidResponse withdrawAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Update the zones for a specific asset to the zone list specified in the defaultZones.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier for the asset to update
      requestBody - null request body
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateAssetZones

      @PostMapping(path="/assets/{assetGUID}/governance-zones") public VoidResponse updateAssetZones(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody List<String> assetZones)
      Update the zones for a specific asset.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier for the asset to update
      assetZones - list of zones for the asset - these values override the current values - null means belongs to no zones.
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • updateAssetOwner

      @PostMapping(path="/assets/{assetGUID}/owner") public VoidResponse updateAssetOwner(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody OwnerRequestBody requestBody)
      Update the owner information for a specific asset.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier for the asset to update
      requestBody - values describing the new owner
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSecurityTags

      @PostMapping(path="/assets/{assetGUID}/security-tags") public VoidResponse addSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody SecurityTagsRequestBody requestBody)
      Add or replace the security tags for an asset or one of its elements.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of asset
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addSecurityTags

      @PostMapping(path="/assets/{assetGUID}/attachments/{assetElementGUID}/security-tags") public VoidResponse addSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String assetElementGUID, @RequestBody SecurityTagsRequestBody requestBody)
      Add or replace the security tags for an asset or one of its elements.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of asset
      assetElementGUID - element to link it to - its type must inherit from Referenceable.
      requestBody - list of security labels and properties
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeSecurityTags

      @PostMapping(path="/assets/{assetGUID}/security-tags/delete") public VoidResponse removeSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove the security tags classification from an asset.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of asset
      requestBody - null request body
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeSecurityTags

      @PostMapping(path="/assets/{assetGUID}/attachments/{assetElementGUID}/security-tags/delete") public VoidResponse removeSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String assetElementGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove the security tags classification to one of an asset's elements.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of asset
      assetElementGUID - element where the security tags need to be removed.
      requestBody - null request body
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • addTemplateClassification

      @PostMapping(path="/assets/{assetGUID}/template-classification") public VoidResponse addTemplateClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) TemplateClassificationRequestBody requestBody)
      Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset to classify
      requestBody - properties of the template
      Returns:
      void or InvalidParameterException asset or element not known, null userId or guid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • removeTemplateClassification

      @PostMapping(path="/assets/{assetGUID}/template-classification/delete") public VoidResponse removeTemplateClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove the classification that indicates that this asset can be used as a template.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset to declassify
      requestBody - null request body
      Returns:
      void or InvalidParameterException asset or element not known, null userId or guid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getAssetsByName

      @PostMapping(path="/assets/by-name") public AssetElementsResponse getAssetsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody NameRequestBody requestBody)
      Return a list of assets with the requested name.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      requestBody - name to search for
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      list of Asset summaries or InvalidParameterException the name is invalid or PropertyServerException there is a problem access in the property server or UserNotAuthorizedException the user does not have access to the properties

    • findAssets

      @PostMapping(path="/assets/by-search-string") public AssetElementsResponse findAssets(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
      Return a list of assets with the requested search string in their name, qualified name or description.
      Parameters:
      serverName - name of the server instances for this request
      userId - calling user
      requestBody - string to search for in text
      startFrom - starting element (used in paging through large result sets)
      pageSize - maximum number of results to return
      Returns:
      list of assets that match the search string or InvalidParameterException the searchString is invalid or PropertyServerException there is a problem access in the property server or UserNotAuthorizedException the user does not have access to the properties

    • getAssetSummary

      @GetMapping(path="/assets/{assetGUID}") public AssetElementResponse getAssetSummary(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID)
      Return the basic attributes of an asset.
      Parameters:
      serverName - server called
      userId - calling user
      assetGUID - unique identifier of the asset
      Returns:
      basic asset properties InvalidParameterException one of the parameters is null or invalid. UserNotAuthorizedException user not authorized to issue this request. PropertyServerException there was a problem that occurred within the property server.

    • getDiscoveryAnalysisReports

      @GetMapping(path="/assets/{assetGUID}/discovery-analysis-reports") public SurveyReportsResponse getDiscoveryAnalysisReports(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestParam int startingFrom, @RequestParam int maximumResults)
      Return the discovery analysis reports about the asset.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset
      startingFrom - position in the list (used when there are so many reports that paging is needed
      maximumResults - maximum number of elements to return on this call
      Returns:
      list of discovery analysis reports or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getDiscoveryReportAnnotations

      @GetMapping(path="/discovery-analysis-reports/{discoveryReportGUID}/annotations") public AnnotationsResponse getDiscoveryReportAnnotations(@PathVariable String serverName, @PathVariable String userId, @PathVariable String discoveryReportGUID, @RequestParam int startingFrom, @RequestParam int maximumResults, @RequestBody AnnotationStatusRequestBody requestBody)
      Return the annotations linked directly to the report.
      Parameters:
      serverName - name of the server instance to connect to
      userId - identifier of calling user
      discoveryReportGUID - identifier of the discovery request.
      startingFrom - initial position in the stored list.
      maximumResults - maximum number of definitions to return on this call.
      requestBody - status of the desired annotations - null means all statuses.
      Returns:
      list of annotations or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • getExtendedAnnotations

      @GetMapping(path="/annotations/{annotationGUID}/annotations") public AnnotationsResponse getExtendedAnnotations(@PathVariable String serverName, @PathVariable String userId, @PathVariable String annotationGUID, @RequestParam int startingFrom, @RequestParam int maximumResults, @RequestBody AnnotationStatusRequestBody requestBody)
      Return any annotations attached to this annotation.
      Parameters:
      serverName - name of the server instance to connect to
      userId - identifier of calling user
      annotationGUID - anchor annotation
      startingFrom - starting position in the list
      maximumResults - maximum number of annotations that can be returned.
      requestBody - status of the desired annotations - null means all statuses.
      Returns:
      list of Annotation objects or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • deleteAsset

      @PostMapping(path="/assets/{assetGUID}/delete") public VoidResponse deleteAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) NullRequestBody requestBody)
      Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback. Given the depth of the elements deleted by this call, it should be used with care.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      assetGUID - unique identifier of the asset to attach the connection to
      requestBody - dummy request body to satisfy POST protocol.
      Returns:
      void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • linkElementsAsPeerDuplicates

      @PostMapping(path="/elements/{element1GUID}/duplicate-of/{element2GUID}") public VoidResponse linkElementsAsPeerDuplicates(@PathVariable String serverName, @PathVariable String userId, @PathVariable String element1GUID, @PathVariable String element2GUID, @RequestBody(required=false) NullRequestBody requestBody)
      Create a simple relationship between two elements in an Asset description (typically the asset itself or attributes in their schema).
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      element1GUID - unique identifier of first element
      element2GUID - unique identifier of second element
      requestBody - dummy request body to satisfy POST protocol.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

    • unlinkElementsAsPeerDuplicates

      @PostMapping(path="/elements/{element1GUID}/duplicate-of/{element2GUID}/delete") public VoidResponse unlinkElementsAsPeerDuplicates(@PathVariable String serverName, @PathVariable String userId, @PathVariable String element1GUID, @PathVariable String element2GUID, @RequestBody(required=false) NullRequestBody requestBody)
      Remove the relationship between two elements that marks them as duplicates.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      element1GUID - unique identifier of first element
      element2GUID - unique identifier of second element
      requestBody - dummy request body to satisfy POST protocol.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem