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 Summary

    Constructors
    Constructor
    Description
    AssetOwnerResource()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addAssetOrigin(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.rest.OriginRequestBody requestBody)
    Set up the labels that classify an asset's origin.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addAssetToCatalog(String serverName, String userId, String typeName, org.odpi.openmetadata.accessservices.assetowner.properties.AssetProperties requestBody)
    Add a simple asset description to the catalog.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addAssetToCatalogUsingTemplate(String serverName, String userId, String templateGUID, org.odpi.openmetadata.accessservices.assetowner.properties.TemplateProperties requestBody)
    Create a new metadata element to represent an asset using an existing asset as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addCombinedSchemaToAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.rest.CombinedSchemaRequestBody schemaInformation)
    Deprecated.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addComplexSchemaToAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.rest.CombinedSchemaRequestBody schemaInformation)
    Stores the supplied schema details in the catalog and attaches it to the asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addConnectionToAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.rest.ConnectionRequestBody requestBody)
    Adds a connection to an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addSchemaAttribute(String serverName, String userId, String assetGUID, String parentGUID, org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties schemaAttribute)
    Adds the attribute to a complex schema type like a relational table, avro schema or a structured document.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addSchemaAttribute(String serverName, String userId, String assetGUID, String parentGUID, org.odpi.openmetadata.accessservices.assetowner.rest.SchemaAttributeRequestBody schemaAttribute)
    Deprecated.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSchemaAttributes(String serverName, String userId, String assetGUID, String parentGUID, List<org.odpi.openmetadata.accessservices.assetowner.properties.SchemaAttributeProperties> schemaAttributes)
    Adds attributes to a complex schema type like a relational table, avro schema or a structured document.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSchemaAttributes(String serverName, String userId, String assetGUID, String parentGUID, org.odpi.openmetadata.accessservices.assetowner.rest.SchemaAttributesRequestBody schemaAttributes)
    Adds attributes to a complex schema type like a relational table, avro schema or a structured document.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addSchemaTypeToAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.properties.SchemaTypeProperties schemaType)
    Stores the supplied schema type in the catalog and attaches it to the asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    addSchemaTypeToAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.rest.SchemaTypeRequestBody schemaType)
    Deprecated.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSecurityTags(String serverName, String userId, String assetGUID, String assetElementGUID, org.odpi.openmetadata.accessservices.assetowner.rest.SecurityTagsRequestBody requestBody)
    Add or replace the security tags for an asset or one of its elements.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSecurityTags(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.rest.SecurityTagsRequestBody requestBody)
    Add or replace the security tags for an asset or one of its elements.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Create a simple relationship between a glossary term and an Asset description.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    addTemplateClassification(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.rest.TemplateClassificationRequestBody requestBody)
    Classify an asset as suitable to be used as a template for cataloguing assets of a similar types.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    attachSchemaTypeToAsset(String serverName, String userId, String assetGUID, String schemaTypeGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Links the supplied schema type directly to the asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deleteAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.commonservices.ffdc.rest.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.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    deleteAssetSchemaType(String serverName, String userId, String assetGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Detaches and deletes an asset's schema.
    org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse
    detachSchemaTypeFromAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Unlinks the schema from the asset but does not delete it.
    org.odpi.openmetadata.accessservices.assetowner.rest.AssetElementsResponse
    findAssets(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody requestBody)
    Return a list of assets with the requested search string in their name, qualified name or description.
    org.odpi.openmetadata.accessservices.assetowner.rest.AssetElementsResponse
    getAssetsByName(String serverName, String userId, int startFrom, int pageSize, org.odpi.openmetadata.commonservices.ffdc.rest.NameRequestBody requestBody)
    Return a list of assets with the requested name.
    org.odpi.openmetadata.accessservices.assetowner.rest.AssetElementResponse
    getAssetSummary(String serverName, String userId, String assetGUID)
    Return the basic attributes of an asset.
    org.odpi.openmetadata.accessservices.assetowner.rest.DiscoveryAnalysisReportListResponse
    getDiscoveryAnalysisReports(String serverName, String userId, String assetGUID, int startingFrom, int maximumResults)
    Return the discovery analysis reports about the asset.
    org.odpi.openmetadata.accessservices.assetowner.rest.AnnotationListResponse
    getDiscoveryReportAnnotations(String serverName, String userId, String discoveryReportGUID, int startingFrom, int maximumResults, org.odpi.openmetadata.accessservices.assetowner.rest.StatusRequestBody requestBody)
    Return the annotations linked directly to the report.
    org.odpi.openmetadata.accessservices.assetowner.rest.AnnotationListResponse
    getExtendedAnnotations(String serverName, String userId, String annotationGUID, int startingFrom, int maximumResults, org.odpi.openmetadata.accessservices.assetowner.rest.StatusRequestBody requestBody)
    Return any annotations attached to this annotation.
    org.odpi.openmetadata.commonservices.ffdc.rest.NameListResponse
    getTypesOfAsset(String serverName, String userId)
    Return the asset subtype names.
    org.odpi.openmetadata.commonservices.ffdc.rest.StringMapResponse
    getTypesOfAssetDescriptions(String serverName, String userId)
    Return the asset subtype names mapped to their descriptions.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    linkElementsAsPeerDuplicates(String serverName, String userId, String element1GUID, String element2GUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Create a simple relationship between two elements in an Asset description (typically the asset itself or attributes in their schema).
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    publishAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Update the zones for a specific asset to the zone list specified in the publishZones.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeAssetOrigin(String serverName, String userId, String assetGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the asset origin classification to an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeSecurityTags(String serverName, String userId, String assetGUID, String assetElementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the security tags classification to one of an asset's elements.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeSecurityTags(String serverName, String userId, String assetGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the security tags classification from an asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    removeTemplateClassification(String serverName, String userId, String assetGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the classification that indicates that this asset can be used as a template.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    unlinkElementsAsPeerDuplicates(String serverName, String userId, String element1GUID, String element2GUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Remove the relationship between two elements that marks them as duplicates.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateAsset(String serverName, String userId, String assetGUID, boolean isMergeUpdate, org.odpi.openmetadata.accessservices.assetowner.properties.AssetProperties requestBody)
    Update a simple asset description to the catalog.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateAssetOwner(String serverName, String userId, String assetGUID, org.odpi.openmetadata.accessservices.assetowner.rest.OwnerRequestBody requestBody)
    Update the owner information for a specific asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    updateAssetZones(String serverName, String userId, String assetGUID, List<String> assetZones)
    Update the zones for a specific asset.
    org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse
    withdrawAsset(String serverName, String userId, String assetGUID, org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody requestBody)
    Update the zones for a specific asset to the zone list specified in the defaultZones.

    Methods inherited from class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • AssetOwnerResource

      public AssetOwnerResource()
      Default constructor

  • Method Details

    • getTypesOfAsset

      @GetMapping(path="/assets/sub-types") public org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addAssetToCatalog(@PathVariable String serverName, @PathVariable String userId, @PathVariable String typeName, @RequestBody org.odpi.openmetadata.accessservices.assetowner.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addAssetToCatalogUsingTemplate(@PathVariable String serverName, @PathVariable String userId, @PathVariable String templateGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.properties.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestParam boolean isMergeUpdate, @RequestBody org.odpi.openmetadata.accessservices.assetowner.properties.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

    • addCombinedSchemaToAsset

      @PostMapping(path="/assets/{assetGUID}/schemas/top-level-schema-type-with-attributes") @Deprecated public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addCombinedSchemaToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addComplexSchemaToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addSchemaTypeToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.properties.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

    • addSchemaTypeToAsset

      @PostMapping(path="/assets/{assetGUID}/schemas/top-level-schema-type") @Deprecated public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addSchemaTypeToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.SchemaTypeRequestBody schemaType)
      Deprecated.
      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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse attachSchemaTypeToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String schemaTypeGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse detachSchemaTypeFromAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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/top-level-schema-type/delete") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteAssetSchemaType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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

    • addSchemaAttributes

      @PostMapping(path="/assets/{assetGUID}/schemas/{parentGUID}/schema-attributes/list/deprecated") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSchemaAttributes(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String parentGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.SchemaAttributesRequestBody 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

    • addSchemaAttributes

      @PostMapping(path="/assets/{assetGUID}/schemas/{parentGUID}/schema-attributes/list") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSchemaAttributes(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String parentGUID, @RequestBody List<org.odpi.openmetadata.accessservices.assetowner.properties.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/deprecated") @Deprecated public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addSchemaAttribute(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String parentGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.SchemaAttributeRequestBody schemaAttribute)
      Deprecated.
      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

    • addSchemaAttribute

      @PostMapping(path="/assets/{assetGUID}/schemas/{parentGUID}/schema-attributes") public org.odpi.openmetadata.commonservices.ffdc.rest.GUIDResponse addSchemaAttribute(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String parentGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.properties.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

    • addConnectionToAsset

      @PostMapping(path="/assets/{assetGUID}/connection") public org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addConnectionToAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.ConnectionRequestBody 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String glossaryTermGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.NullRequestBody 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String glossaryTermGUID, @PathVariable String assetElementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String glossaryTermGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeSemanticAssignment(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String glossaryTermGUID, @PathVariable String assetElementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addAssetOrigin(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeAssetOrigin(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse publishAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse withdrawAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse updateAssetOwner(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String assetElementGUID, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeSecurityTags(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @PathVariable String assetElementGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse addTemplateClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.accessservices.assetowner.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse removeTemplateClassification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.accessservices.assetowner.rest.AssetElementsResponse getAssetsByName(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.accessservices.assetowner.rest.AssetElementsResponse findAssets(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.accessservices.assetowner.rest.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 org.odpi.openmetadata.accessservices.assetowner.rest.DiscoveryAnalysisReportListResponse 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 org.odpi.openmetadata.accessservices.assetowner.rest.AnnotationListResponse getDiscoveryReportAnnotations(@PathVariable String serverName, @PathVariable String userId, @PathVariable String discoveryReportGUID, @RequestParam int startingFrom, @RequestParam int maximumResults, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.StatusRequestBody 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 org.odpi.openmetadata.accessservices.assetowner.rest.AnnotationListResponse getExtendedAnnotations(@PathVariable String serverName, @PathVariable String userId, @PathVariable String annotationGUID, @RequestParam int startingFrom, @RequestParam int maximumResults, @RequestBody org.odpi.openmetadata.accessservices.assetowner.rest.StatusRequestBody 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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse deleteAsset(@PathVariable String serverName, @PathVariable String userId, @PathVariable String assetGUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse linkElementsAsPeerDuplicates(@PathVariable String serverName, @PathVariable String userId, @PathVariable String element1GUID, @PathVariable String element2GUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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 org.odpi.openmetadata.commonservices.ffdc.rest.VoidResponse unlinkElementsAsPeerDuplicates(@PathVariable String serverName, @PathVariable String userId, @PathVariable String element1GUID, @PathVariable String element2GUID, @RequestBody(required=false) org.odpi.openmetadata.commonservices.ffdc.rest.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