Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

The Connected Asset OMAS is an API that is available on implements the open metadata ConnectedAssetProperties API for an OCF connector.  An OCF connector is a connector that supports the Open Connector Framework (OCF). It has 3 two APIs:

  • An API to access the asset it connects to
  • An API to access the metadata about the asset the connector is used to access
  • An API to access and use an audit log file for the asset
  • accesses

The ConnectedAssetProperties The Connected Asset OMAS is the second API on an OCF connector - the one for the metadata about the asset.   It is a generic API for all types of open metadata assets. However, it assumes the asset's metadata model inherits from Asset (see model 0010 in Area 0).

...

The Connected Asset OMAS returns metadata about the asset at three levels of detail:

  • assetSummary Asset Summary - used for displaying details of the asset in summary lists or hover text
    • assetShortDescription Type - short description about the asset (assetSummary from ConnectionsToAsset - model 0105 in Area 1)assetTypeId - GUID for the information about the specific type of the asset
    • assetTypeName QualifiedName - official name of the asset type (name from the model
    • assetTypeVersion - version id of the type
    • Asset - model 0010 in Area 0)
    • ShortDescription - short description about assetName - official name of the asset (name assetSummary property from Asset ConnectionsToAsset relationship - model 0010 0105 in Area 02)
    • assetDescription Description - full description of the asset (description from Asset - model 0010)
    • assetOwner Owner - name of the person or organization that owns the asset (owner from Asset - model 0010)
    • assetClassifications Classifications - list of classifications assigned directly to the asset, or its schema/definitions
  • assetDetail - Asset Detail - adds the following information to Asset Summary.  It is used to display all of the information known about the asset with summaries of the relationships to other metadata
    • assetSummary Properties - see aboveassetProperties - properties and structs nested structures for the asset (these are defined in the type model)
    • assetRelationships Relationships - summaries of the relationships to other assets
  • assetUniverse - use Asset Universe - adds the following information to Asset Detail.  It is used to define the broader context for the asset
    • assetDetail - see above
    • assetInfrastructure Infrastructure - details of the underlying infrastructure supporting the asset (all from Area 0)
    • assetDefinitions Collaboration - details of the schema(s) and definitions associated with to the people, products and feedback that are connected to the asset (see Area 2 and Area 5 1 of the model)assetCollaboration
    • Definitions - details to the people, products and feedback that are connected to of the schema(s) and definitions associated with the asset (see Area 3 and Area 5 of the model)
    • assetGovernance Governance - the list of governance requirements, typically associated with the classifications associated with the asset (see Area 4 of the model).
    • assetAnnotations Annotations - details of the annotation added by the discovery services (see Area 6 of the model)
    • assetLineage Lineage - details of the lineage for the asset (see Area 7 of the model)

 

...

    • model

...

    • )

...

The ConnectedAssetOMASAPI object supports the following methods/operations:

  • getAssetSummary - returns the summary information organized in the assetSummary structure described above.
  • getAssetDetail - returns detailed information about the asset organized in the assetDetail structure described above.
  • getAssetUniverse - returns all of the detail of the asset and information connected to it in organized in the assetUniverse structure described above.
  • addAssetTag - allows a new tag (private or public) to be added to the assets metadata (see model 0350 in Area 3).
  • addAssetRating - allows a rating to be added to the asset (see model 0350 in Area 3).
  • addAssetLike - add a "Like" to the asset (see model 0350 in Area 3).
  • addAssetComment - add a comment to the asset (see model 0350 in Area 3).
  • addAssetToCollection - add the asset to the requested collection (see model 0320 in Area 3).

...

 

...