-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #798 from alexandra-bucur/asset-catalog-tech-preview
Document Asset Catalog and move it to Tech Preview
- Loading branch information
Showing
9 changed files
with
574 additions
and
24 deletions.
There are no files selected for viewing
36 changes: 36 additions & 0 deletions
36
site/docs/services/omas/asset-catalog/get-asset-classifications.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Get Asset Classifications | ||
|
||
This is the ability to retrieve all classifications that exist on a specific asset. | ||
|
||
## Java client | ||
|
||
AssetCatalog.java, method (more details in javadoc): [ClassificationListResponse getClassificationsForAsset(String userId, String assetGUID, String assetType, String classificationName) throws InvalidParameterException, PropertyServerException;](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/assetcatalog/AssetCatalog.html#getClassificationsForAsset(java.lang.String,java.lang.String,java.lang.String,java.lang.String)) | ||
|
||
## REST endpoint | ||
``` | ||
GET {{base-url}}/servers/{{server-id}}/open-metadata/access-services/asset-catalog/users/{{user-id}}/supportedTypes | ||
``` | ||
Path and request parameters: | ||
* `serverName` - unique identifier for requested server | ||
* `userId` - the unique identifier for the user | ||
* `assetGUID` - the unique identifier for the asset | ||
* `assetType` - the type of the asset | ||
* `classificationName` - the name of the classification | ||
|
||
Response: | ||
* `ClassificationsResponse` - the classification for the asset | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json). | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
37 changes: 37 additions & 0 deletions
37
site/docs/services/omas/asset-catalog/get-asset-context.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Get Asset Context | ||
|
||
Return the full context of an asset/glossary term based on its identifier. | ||
The response contains the list of the connections assigned to the asset. | ||
|
||
## Java client | ||
|
||
AssetCatalog.java, method (more details in javadoc): [AssetResponse getAssetContext(String userId, String assetGUID, String assetType) throws InvalidParameterException, PropertyServerException;](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/assetcatalog/AssetCatalog.html#getAssetContext(java.lang.String,java.lang.String,java.lang.String)) | ||
|
||
## REST endpoint | ||
|
||
``` | ||
GET {{base-url}}/servers/{{server-id}}/open-metadata/access-services/asset-catalog/users/{{user-id}}/asset-context/{{asset-guid}} | ||
``` | ||
Path and request parameters: | ||
* `serverName` - unique identifier for requested server. | ||
* `userId` - the unique identifier for the user | ||
* `assetGUID` - the global unique identifier of the asset | ||
* `assetType` - the type of the asset | ||
|
||
Response: | ||
* `AssetResponse` - list of properties used to narrow the search | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json). | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
36 changes: 36 additions & 0 deletions
36
site/docs/services/omas/asset-catalog/get-asset-details.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Get Asset Details | ||
|
||
Fetches asset's properties, relationships and classifications. | ||
|
||
## Java client | ||
|
||
AssetCatalog.java, method (more details in javadoc): [AssetCatalogResponse getAssetDetails(String userId, String assetGUID, String assetType) throws InvalidParameterException, PropertyServerException;](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/assetcatalog/AssetCatalog.html#getAssetDetails(java.lang.String,java.lang.String,java.lang.String)) | ||
|
||
## REST endpoint | ||
|
||
``` | ||
GET {{base-url}}/servers/{{server-id}}/open-metadata/access-services/asset-catalog/users/{{user-id}}/asset-details/{{asset-guid}} | ||
``` | ||
Path and request parameters: | ||
* `serverName` - unique identifier for requested server. | ||
* `userId` - the unique identifier for the user | ||
* `assetGUID` - the global unique identifier of the asset | ||
* `assetType` - the type of the asset | ||
|
||
Response: | ||
* `AssetCatalogResponse` - list of properties used to narrow the search | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json). | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
39 changes: 39 additions & 0 deletions
39
site/docs/services/omas/asset-catalog/get-asset-relationships.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Get Asset Relationships | ||
|
||
Fetches the relationships for a specific asset. | ||
|
||
## Java client | ||
|
||
AssetCatalog.java, method (more details in javadoc): [RelationshipResponse getRelationshipBetweenEntities(String userId, String entity1GUID, String entity2GUID, String relationshipType) throws InvalidParameterException, PropertyServerException;](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/assetcatalog/AssetCatalog.html#getRelationshipBetweenEntities(java.lang.String,java.lang.String,java.lang.String,java.lang.String)) | ||
|
||
## REST endpoint | ||
|
||
``` | ||
GET {{base-url}}/servers/{{server-id}}/open-metadata/access-services/asset-catalog/users/{{user-id}}/asset-relationships/{{asset-guid}}?assetType={{asset-type}}&relationshipType={{relationship-type}} | ||
``` | ||
Path and request parameters: | ||
* `serverName` - unique identifier for requested server | ||
* `userId` - the unique identifier for the user | ||
* `assetGUID` - the unique identifier for the asset | ||
* `assetType` - the type of the asset | ||
* `relationshipType` - the type of the relationship | ||
* `from` - offset | ||
* `pageSize` - limit the number of the assets returned | ||
|
||
Response: | ||
* `RelationshipListResponse` - list of relationships for the given asset | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json). | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
36 changes: 36 additions & 0 deletions
36
site/docs/services/omas/asset-catalog/get-asset-universe.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Get Asset Universe | ||
|
||
Fetches asset's header, classification, properties and relationships. | ||
|
||
## Java client | ||
|
||
AssetCatalog.java, method (more details in javadoc): [AssetCatalogResponse getAssetUniverse(String userId, String assetGUID, String assetType) throws InvalidParameterException, PropertyServerException;](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/assetcatalog/AssetCatalog.html#getAssetUniverse(java.lang.String,java.lang.String,java.lang.String)) | ||
|
||
## REST endpoint | ||
|
||
``` | ||
GET {{base-url}}/servers/{{server-id}}/open-metadata/access-services/asset-catalog/users/{{user-id}}/asset-relationships/{{asset-guid}}?assetType={{asset-type}}&relationshipType={{relationship-type}} | ||
``` | ||
Path and request parameters: | ||
* `serverName` - unique identifier for requested server | ||
* `userId` - the unique identifier for the user | ||
* `assetGUID` - the unique identifier for the asset | ||
* `assetType` - the type of the asset | ||
|
||
Response: | ||
* `AssetCatalogResponse` - the asset with its header and the list of associated classifications and relationship | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json). | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
35 changes: 35 additions & 0 deletions
35
site/docs/services/omas/asset-catalog/get-supported-types.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Get Supported Types | ||
|
||
Returns the list with supported types for search, including the sub-types supported. | ||
|
||
## Java client | ||
|
||
AssetCatalog.java, method (more details in javadoc): [AssetCatalogSupportedTypes getSupportedTypes(String userId, String type) throws InvalidParameterException, PropertyServerException;](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/assetcatalog/AssetCatalog.html#getSupportedTypes(java.lang.String,java.lang.String)) | ||
|
||
## REST endpoint | ||
|
||
``` | ||
GET {{base-url}}/servers/{{server-id}}/open-metadata/access-services/asset-catalog/users/{{user-id}}/supportedTypes | ||
``` | ||
Path and request parameters: | ||
* `serverName` - unique identifier for requested server | ||
* `userId` - the unique identifier for the user | ||
* `type` - the type | ||
|
||
Response: | ||
* `AssetCatalogSupportedTypes` - list of types and sub-types supported for search | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json). | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.