Skip to content

Commit

Permalink
Add java client details for Asset Catalog methods
Browse files Browse the repository at this point in the history
Signed-off-by: Alexandra Bucur <alexandra-nona.bucur@ing.com>
  • Loading branch information
Alexandra Bucur committed Jun 20, 2023
1 parent 2f0072a commit fdda272
Show file tree
Hide file tree
Showing 7 changed files with 60 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@

This is the ability to retrieve all classifications that exist on a specific asset.

More examples can be found in the
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json)
## 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
```
Expand All @@ -21,6 +23,9 @@ Path and request parameters:
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"


Expand Down
10 changes: 8 additions & 2 deletions site/docs/services/omas/asset-catalog/get-asset-context.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@
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.

More examples can be found in the
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json)
## 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}}
Expand All @@ -21,6 +24,9 @@ Path and request parameters:
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"


Expand Down
12 changes: 9 additions & 3 deletions site/docs/services/omas/asset-catalog/get-asset-details.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@

# Get Asset Details

Fetches asset's properties, relationships and classifications
Fetches asset's properties, relationships and classifications.

More examples can be found in the
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json)
## 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}}
Expand All @@ -20,6 +23,9 @@ Path and request parameters:
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"


Expand Down
12 changes: 9 additions & 3 deletions site/docs/services/omas/asset-catalog/get-asset-relationships.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@

# Get Asset Relationships

Fetches the relationships for a specific asset
Fetches the relationships for a specific asset.

More examples can be found in the
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json)
## 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}}
Expand All @@ -23,6 +26,9 @@ Path and request parameters:
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"


Expand Down
12 changes: 9 additions & 3 deletions site/docs/services/omas/asset-catalog/get-asset-universe.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@

# Get Asset Universe

Fetches asset's header, classification, properties and relationships
Fetches asset's header, classification, properties and relationships.

More examples can be found in the
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json)
## 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}}
Expand All @@ -20,6 +23,9 @@ Path and request parameters:
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"


Expand Down
12 changes: 9 additions & 3 deletions site/docs/services/omas/asset-catalog/get-supported-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@

# Get Supported Types

Returns the list with supported types for search, including the sub-types supported
Returns the list with supported types for search, including the sub-types supported.

More examples can be found in the
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json)
## 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
Expand All @@ -19,6 +22,9 @@ Path and request parameters:
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"


Expand Down
12 changes: 9 additions & 3 deletions site/docs/services/omas/asset-catalog/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,13 @@

# Search

Returns the list with supported types for search, including the sub-types supported
Returns the list with supported types for search, including the sub-types supported.

More examples can be found in the
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json)
## Java client

AssetCatalog.java, method (more details in javadoc): [AssetListResponse searchByType(String userId, String searchCriteria, SearchParameters searchParameters) throws InvalidParameterException, PropertyServerException;](https://odpi.github.io/egeria/org/odpi/openmetadata/accessservices/assetcatalog/AssetCatalog.html#searchByType(java.lang.String,java.lang.String,org.odpi.openmetadata.accessservices.assetcatalog.model.rest.body.SearchParameters))

## REST endpoint

```
GET {{base-url}}/servers/{{server-id}}/open-metadata/access-services/asset-catalog/users/{{user-id}}/supportedTypes
Expand All @@ -20,6 +23,9 @@ Path and request parameters:
Response:
* `AssetListResponse` - list of found assets

More examples can be found in the
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json).

---8<-- "snippets/abbr.md"


Expand Down

0 comments on commit fdda272

Please sign in to comment.