-
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.
Document Asset Catalog and move it to Tech Preview
Signed-off-by: Alexandra Bucur <alexandra-nona.bucur@ing.com>
- Loading branch information
Alexandra Bucur
committed
Jun 8, 2023
1 parent
b2f37f9
commit 2f0072a
Showing
9 changed files
with
533 additions
and
24 deletions.
There are no files selected for viewing
31 changes: 31 additions & 0 deletions
31
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,31 @@ | ||
<!-- 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. | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json) | ||
|
||
``` | ||
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 | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
31 changes: 31 additions & 0 deletions
31
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,31 @@ | ||
<!-- 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. | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json) | ||
|
||
``` | ||
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 | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
30 changes: 30 additions & 0 deletions
30
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,30 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Get Asset Details | ||
|
||
Fetches asset's properties, relationships and classifications | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json) | ||
|
||
``` | ||
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 | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
33 changes: 33 additions & 0 deletions
33
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,33 @@ | ||
<!-- SPDX-License-Identifier: CC-BY-4.0 --> | ||
<!-- Copyright Contributors to the ODPi Egeria project. --> | ||
|
||
# Get Asset Relationships | ||
|
||
Fetches the relationships for a specific asset | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json) | ||
|
||
``` | ||
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 | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
30 changes: 30 additions & 0 deletions
30
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,30 @@ | ||
<!-- 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 | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json) | ||
|
||
``` | ||
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 | ||
|
||
---8<-- "snippets/abbr.md" | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
29 changes: 29 additions & 0 deletions
29
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,29 @@ | ||
<!-- 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 | ||
|
||
More examples can be found in the | ||
[sample collection](samples/collections/Asset-Catalog-endpoints.postman_collection.json) | ||
|
||
``` | ||
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 | ||
|
||
---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.