diff --git a/site/docs/services/omas/asset-catalog/get-asset-classifications.md b/site/docs/services/omas/asset-catalog/get-asset-classifications.md index 52ce138b2f..916e3b6f78 100644 --- a/site/docs/services/omas/asset-catalog/get-asset-classifications.md +++ b/site/docs/services/omas/asset-catalog/get-asset-classifications.md @@ -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 ``` @@ -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" diff --git a/site/docs/services/omas/asset-catalog/get-asset-context.md b/site/docs/services/omas/asset-catalog/get-asset-context.md index 02137bfed2..bd4eb1a67a 100644 --- a/site/docs/services/omas/asset-catalog/get-asset-context.md +++ b/site/docs/services/omas/asset-catalog/get-asset-context.md @@ -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}} @@ -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" diff --git a/site/docs/services/omas/asset-catalog/get-asset-details.md b/site/docs/services/omas/asset-catalog/get-asset-details.md index 7c420d731e..04acda61c9 100644 --- a/site/docs/services/omas/asset-catalog/get-asset-details.md +++ b/site/docs/services/omas/asset-catalog/get-asset-details.md @@ -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}} @@ -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" diff --git a/site/docs/services/omas/asset-catalog/get-asset-relationships.md b/site/docs/services/omas/asset-catalog/get-asset-relationships.md index 3c53c7d2a6..946e9c82fa 100644 --- a/site/docs/services/omas/asset-catalog/get-asset-relationships.md +++ b/site/docs/services/omas/asset-catalog/get-asset-relationships.md @@ -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}} @@ -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" diff --git a/site/docs/services/omas/asset-catalog/get-asset-universe.md b/site/docs/services/omas/asset-catalog/get-asset-universe.md index 3f2ccff5b2..2c3e9078d3 100644 --- a/site/docs/services/omas/asset-catalog/get-asset-universe.md +++ b/site/docs/services/omas/asset-catalog/get-asset-universe.md @@ -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}} @@ -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" diff --git a/site/docs/services/omas/asset-catalog/get-supported-types.md b/site/docs/services/omas/asset-catalog/get-supported-types.md index 66bfaf4276..8598e4f23a 100644 --- a/site/docs/services/omas/asset-catalog/get-supported-types.md +++ b/site/docs/services/omas/asset-catalog/get-supported-types.md @@ -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 @@ -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" diff --git a/site/docs/services/omas/asset-catalog/search.md b/site/docs/services/omas/asset-catalog/search.md index a72c429247..e5e124ba24 100644 --- a/site/docs/services/omas/asset-catalog/search.md +++ b/site/docs/services/omas/asset-catalog/search.md @@ -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 @@ -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"