public class DataAssetExchangeRESTServices extends Object
| Constructor and Description |
|---|
DataAssetExchangeRESTServices()
Default constructor
|
| Modifier and Type | Method and Description |
|---|---|
VoidResponse |
clearAssetAsReferenceData(String serverName,
String userId,
String assetGUID,
MetadataCorrelationProperties requestBody)
Remove the reference data designation from the asset.
|
GUIDResponse |
createAsset(String serverName,
String userId,
boolean assetManagerIsHome,
AssetRequestBody requestBody)
Create a new metadata element to represent the root of an asset.
|
GUIDResponse |
createAssetFromTemplate(String serverName,
String userId,
String templateGUID,
TemplateRequestBody requestBody)
Create a new metadata element to represent an asset using an existing metadata element as a template.
|
AssetElementsResponse |
findAssets(String serverName,
String userId,
int startFrom,
int pageSize,
SearchStringRequestBody requestBody)
Retrieve the list of asset metadata elements that contain the search string.
|
AssetElementResponse |
getAssetByGUID(String serverName,
String userId,
String assetGUID,
AssetManagerIdentifiersRequestBody requestBody)
Retrieve the asset metadata element with the supplied unique identifier.
|
AssetElementsResponse |
getAssetsByName(String serverName,
String userId,
int startFrom,
int pageSize,
NameRequestBody requestBody)
Retrieve the list of asset metadata elements with a matching qualified or display name.
|
AssetElementsResponse |
getAssetsForAssetManager(String serverName,
String userId,
int startFrom,
int pageSize,
AssetManagerIdentifiersRequestBody requestBody)
Retrieve the list of assets created on behalf of the named asset manager.
|
VoidResponse |
publishAsset(String serverName,
String userId,
String assetGUID,
AssetManagerIdentifiersRequestBody requestBody)
Update the zones for the asset so that it becomes visible to consumers.
|
VoidResponse |
removeAsset(String serverName,
String userId,
String assetGUID,
MetadataCorrelationProperties requestBody)
Remove the metadata element representing an asset.
|
VoidResponse |
setAssetAsReferenceData(String serverName,
String userId,
String assetGUID,
MetadataCorrelationProperties requestBody)
Classify the asset to indicate that it can be used as reference data.
|
VoidResponse |
updateAsset(String serverName,
String userId,
String assetGUID,
boolean isMergeUpdate,
AssetRequestBody requestBody)
Update the metadata element representing an asset.
|
VoidResponse |
withdrawAsset(String serverName,
String userId,
String assetGUID,
AssetManagerIdentifiersRequestBody requestBody)
Update the zones for the asset so that it is no longer visible to consumers.
|
public DataAssetExchangeRESTServices()
public GUIDResponse createAsset(String serverName, String userId, boolean assetManagerIsHome, AssetRequestBody requestBody)
serverName - name of the server to route the request touserId - calling userassetManagerIsHome - ensure that only the asset manager can update this assetrequestBody - properties to storepublic GUIDResponse createAssetFromTemplate(String serverName, String userId, String templateGUID, TemplateRequestBody requestBody)
serverName - name of the server to route the request touserId - calling usertemplateGUID - unique identifier of the metadata element to copyrequestBody - properties that override the template and correlate to external identifierspublic VoidResponse updateAsset(String serverName, String userId, String assetGUID, boolean isMergeUpdate, AssetRequestBody requestBody)
serverName - name of the server to route the request touserId - calling userassetGUID - unique identifier of the metadata element to updateisMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?requestBody - new properties for this elementpublic VoidResponse publishAsset(String serverName, String userId, String assetGUID, AssetManagerIdentifiersRequestBody requestBody)
serverName - name of the server to route the request touserId - calling userassetGUID - unique identifier of the metadata element to publishrequestBody - correlation propertiespublic VoidResponse withdrawAsset(String serverName, String userId, String assetGUID, AssetManagerIdentifiersRequestBody requestBody)
serverName - name of the server to route the request touserId - calling userassetGUID - unique identifier of the metadata element to withdrawrequestBody - correlation propertiespublic VoidResponse removeAsset(String serverName, String userId, String assetGUID, MetadataCorrelationProperties requestBody)
serverName - name of the server to route the request touserId - calling userassetGUID - unique identifier of the metadata element to removerequestBody - correlation propertiespublic VoidResponse setAssetAsReferenceData(String serverName, String userId, String assetGUID, MetadataCorrelationProperties requestBody)
serverName - name of the server to route the request touserId - calling userassetGUID - unique identifier of the metadata element to updaterequestBody - correlation propertiespublic VoidResponse clearAssetAsReferenceData(String serverName, String userId, String assetGUID, MetadataCorrelationProperties requestBody)
serverName - name of the server to route the request touserId - calling userassetGUID - unique identifier of the metadata element to updaterequestBody - correlation propertiespublic AssetElementsResponse findAssets(String serverName, String userId, int startFrom, int pageSize, SearchStringRequestBody requestBody)
serverName - name of the server to route the request touserId - calling userstartFrom - paging start pointpageSize - maximum results that can be returnedrequestBody - search parameter and correlation propertiespublic AssetElementsResponse getAssetsByName(String serverName, String userId, int startFrom, int pageSize, NameRequestBody requestBody)
serverName - name of the server to route the request touserId - calling userstartFrom - paging start pointpageSize - maximum results that can be returnedrequestBody - search parameter and correlation propertiespublic AssetElementsResponse getAssetsForAssetManager(String serverName, String userId, int startFrom, int pageSize, AssetManagerIdentifiersRequestBody requestBody)
serverName - name of the server to route the request touserId - calling userstartFrom - paging start pointpageSize - maximum results that can be returnedrequestBody - search parameters and correlation propertiespublic AssetElementResponse getAssetByGUID(String serverName, String userId, String assetGUID, AssetManagerIdentifiersRequestBody requestBody)
serverName - name of the server to route the request touserId - calling userassetGUID - unique identifier of the requested metadata elementrequestBody - correlation propertiesCopyright © 2018–2020 ODPi. All rights reserved.