org.odpi.openmetadata.accessservices.assetowner.server.spring

Class AssetOwnerResource

java.lang.Object

org.odpi.openmetadata.accessservices.assetowner.server.spring.AssetOwnerResource

@RestController
 @RequestMapping(value="/servers/{serverName}/open-metadata/access-services/asset-owner/users/{userId}")
public class AssetOwnerResource
extends Object

AssetOwnerResource provides the generic server-side interface for the Asset Owner Open Metadata Access Service (OMAS). There are other resources that provide specialized methods for specific types of Asset.

Constructor Summary

Constructors

Constructor and Description
AssetOwnerResource() Default constructor

Method Summary

Modifier and Type	Method and Description
VoidResponse	addAssetOrigin(String serverName, String userId, String assetGUID, OriginRequestBody requestBody) Set up the labels that classify an asset's origin.
GUIDResponse	addAssetToCatalog(String serverName, String userId, String typeName, AssetRequestBody requestBody) Add a simple asset description to the catalog.
GUIDResponse	addCombinedSchemaToAsset(String serverName, String userId, String assetGUID, CombinedSchemaRequestBody schemaInformation) Stores the supplied schema details in the catalog and attaches it to the asset.
VoidResponse	addConnectionToAsset(String serverName, String userId, String assetGUID, ConnectionRequestBody requestBody) Adds a connection to an asset.
GUIDResponse	addSchemaAttribute(String serverName, String userId, String assetGUID, String parentGUID, SchemaAttributeRequestBody schemaAttribute) Adds the attribute to a complex schema type like a relational table, avro schema or a structured document.
VoidResponse	addSchemaAttributes(String serverName, String userId, String assetGUID, String parentGUID, SchemaAttributesRequestBody schemaAttributes) Adds attributes to a complex schema type like a relational table, avro schema or a structured document.
VoidResponse	addSchemaAttributesToSchema(String serverName, String userId, String schemaTypeGUID, List<SchemaAttribute> schemaAttributes) Deprecated.
GUIDResponse	addSchemaToAsset(String serverName, String userId, String assetGUID, SchemaRequestBody requestBody) Deprecated.
GUIDResponse	addSchemaTypeToAsset(String serverName, String userId, String assetGUID, SchemaTypeRequestBody schemaType) Stores the supplied schema type in the catalog and attaches it to the asset.
VoidResponse	addSecurityTags(String serverName, String userId, String assetGUID, SecurityTagsRequestBody requestBody) Add or replace the security tags for an asset or one of its elements.
VoidResponse	addSecurityTags(String serverName, String userId, String assetGUID, String assetElementGUID, SecurityTagsRequestBody requestBody) Add or replace the security tags for an asset or one of its elements.
VoidResponse	addSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, NullRequestBody requestBody) Create a simple relationship between a glossary term and an Asset description.
VoidResponse	addSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID, NullRequestBody requestBody) Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).
VoidResponse	attachSchemaTypeToAsset(String serverName, String userId, String assetGUID, String schemaTypeGUID, NullRequestBody requestBody) Links the supplied schema type directly to the asset.
VoidResponse	deleteAsset(String serverName, String userId, String assetGUID, NullRequestBody requestBody) Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback.
VoidResponse	deleteAssetSchemaType(String serverName, String userId, String assetGUID, NullRequestBody requestBody) Detaches and deletes an asset's schema.
GUIDResponse	detachSchemaTypeFromAsset(String serverName, String userId, String assetGUID, NullRequestBody requestBody) Unlinks the schema from the asset but does not delete it.
AssetsResponse	findAssets(String serverName, String userId, int startFrom, int pageSize, String searchString) Return a list of assets with the requested search string in their name, qualified name or description.
AssetsResponse	getAssetsByName(String serverName, String userId, int startFrom, int pageSize, String name) Return a list of assets with the requested name.
DiscoveryAnalysisReportListResponse	getDiscoveryAnalysisReports(String serverName, String userId, String assetGUID, int startingFrom, int maximumResults) Return the discovery analysis reports about the asset.
AnnotationListResponse	getDiscoveryReportAnnotations(String serverName, String userId, String discoveryReportGUID, int startingFrom, int maximumResults, StatusRequestBody requestBody) Return the annotations linked directly to the report.
AnnotationListResponse	getExtendedAnnotations(String serverName, String userId, String annotationGUID, int startingFrom, int maximumResults, StatusRequestBody requestBody) Return any annotations attached to this annotation.
NameListResponse	getTypesOfAsset(String serverName, String userId) Return the asset subtype names.
StringMapResponse	getTypesOfAssetDescriptions(String serverName, String userId) Return the asset subtype names mapped to their descriptions.
VoidResponse	removeAssetOrigin(String serverName, String userId, String assetGUID, NullRequestBody requestBody) Remove the asset origin classification to an asset.
VoidResponse	removeSecurityTags(String serverName, String userId, String assetGUID, NullRequestBody requestBody) Remove the security tags classification from an asset.
VoidResponse	removeSecurityTags(String serverName, String userId, String assetGUID, String assetElementGUID, NullRequestBody requestBody) Remove the security tags classification to one of an asset's elements.
VoidResponse	removeSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, NullRequestBody requestBody) Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
VoidResponse	removeSemanticAssignment(String serverName, String userId, String assetGUID, String glossaryTermGUID, String assetElementGUID, NullRequestBody requestBody) Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).
VoidResponse	updateAssetOwner(String serverName, String userId, String assetGUID, OwnerRequestBody requestBody) Update the owner information for a specific asset.
VoidResponse	updateAssetZones(String serverName, String userId, String assetGUID, List<String> assetZones) Update the zones for a specific asset.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetOwnerResource

public AssetOwnerResource()

Default constructor

Method Detail

getTypesOfAsset

@GetMapping(path="/assets/sub-types")
public NameListResponse getTypesOfAsset(@PathVariable
                                                                              String serverName,
                                                                              @PathVariable
                                                                              String userId)

Return the asset subtype names.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

Returns:

list of type names that are subtypes of asset or throws InvalidParameterException full path or userId is null or throws PropertyServerException problem accessing property server or throws UserNotAuthorizedException security access problem.

getTypesOfAssetDescriptions

@GetMapping(path="/assets/sub-types/descriptions")
public StringMapResponse getTypesOfAssetDescriptions(@PathVariable
                                                                                                        String serverName,
                                                                                                        @PathVariable
                                                                                                        String userId)

Return the asset subtype names mapped to their descriptions.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

Returns:

list of type names that are subtypes of asset or throws InvalidParameterException full path or userId is null or throws PropertyServerException problem accessing property server or throws UserNotAuthorizedException security access problem.

addAssetToCatalog

@PostMapping(path="/assets/{typeName}")
public GUIDResponse addAssetToCatalog(@PathVariable
                                                                              String serverName,
                                                                              @PathVariable
                                                                              String userId,
                                                                              @PathVariable
                                                                              String typeName,
                                                                              @RequestBody
                                                                              AssetRequestBody requestBody)

Add a simple asset description to the catalog.

Parameters:

serverName - name of the server instance to connect to

userId - calling user (assumed to be the owner)

typeName - specific type of the asset - this must match a defined subtype

requestBody - other properties for asset

Returns:

unique identifier (guid) of the asset or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addCombinedSchemaToAsset

@PostMapping(path="/assets/{assetGUID}/schemas/top-level-schema-type-with-attributes")
public GUIDResponse addCombinedSchemaToAsset(@PathVariable
                                                                                                                                    String serverName,
                                                                                                                                    @PathVariable
                                                                                                                                    String userId,
                                                                                                                                    @PathVariable
                                                                                                                                    String assetGUID,
                                                                                                                                    @RequestBody
                                                                                                                                    CombinedSchemaRequestBody schemaInformation)

Stores the supplied schema details in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted. If more attributes need to be added in addition to the ones supplied then this can be done with addSchemaAttributesToSchemaType().

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

schemaInformation - schema type to create and attach directly to the asset.

Returns:

guid of the schema type or InvalidParameterException full path or userId is null, or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSchemaTypeToAsset

@PostMapping(path="/assets/{assetGUID}/schemas/top-level-schema-type")
public GUIDResponse addSchemaTypeToAsset(@PathVariable
                                                                                                                String serverName,
                                                                                                                @PathVariable
                                                                                                                String userId,
                                                                                                                @PathVariable
                                                                                                                String assetGUID,
                                                                                                                @RequestBody
                                                                                                                SchemaTypeRequestBody schemaType)

Stores the supplied schema type in the catalog and attaches it to the asset. If another schema is currently attached to the asset, it is unlinked and deleted.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

schemaType - schema type to create and attach directly to the asset.

Returns:

guid of the new schema type or InvalidParameterException full path or userId is null, or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

attachSchemaTypeToAsset

@PostMapping(path="/assets/{assetGUID}/schemas/top-level-schema-type/{schemaTypeGUID}/attach")
public VoidResponse attachSchemaTypeToAsset(@PathVariable
                                                                                                                                           String serverName,
                                                                                                                                           @PathVariable
                                                                                                                                           String userId,
                                                                                                                                           @PathVariable
                                                                                                                                           String assetGUID,
                                                                                                                                           @PathVariable
                                                                                                                                           String schemaTypeGUID,
                                                                                                                                           @RequestBody(required=false)
                                                                                                                                           NullRequestBody requestBody)

Links the supplied schema type directly to the asset. If this schema is either not found, or already attached to an asset, then an error occurs. If another schema is currently attached to the asset, it is unlinked and deleted.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

schemaTypeGUID - unique identifier of the schema type to attach

requestBody - null

Returns:

void or InvalidParameterException full path or userId or one of the GUIDs is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

detachSchemaTypeFromAsset

@PostMapping(path="/assets/{assetGUID}/schemas/top-level-schema-type/detach")
public GUIDResponse detachSchemaTypeFromAsset(@PathVariable
                                                                                                                            String serverName,
                                                                                                                            @PathVariable
                                                                                                                            String userId,
                                                                                                                            @PathVariable
                                                                                                                            String assetGUID,
                                                                                                                            @RequestBody(required=false)
                                                                                                                            NullRequestBody requestBody)

Unlinks the schema from the asset but does not delete it. This means it can be be reattached to a different asset.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

requestBody - null

Returns:

guid of the schema type or InvalidParameterException full path or userId or one of the GUIDs is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

deleteAssetSchemaType

@PostMapping(path="/assets/{assetGUID}/schemas/top-level-schema-type/delete")
public VoidResponse deleteAssetSchemaType(@PathVariable
                                                                                                                        String serverName,
                                                                                                                        @PathVariable
                                                                                                                        String userId,
                                                                                                                        @PathVariable
                                                                                                                        String assetGUID,
                                                                                                                        @RequestBody(required=false)
                                                                                                                        NullRequestBody requestBody)

Detaches and deletes an asset's schema.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

requestBody - null

Returns:

void or InvalidParameterException full path or userId is null, or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSchemaAttributes

@PostMapping(path="/assets/{assetGUID}/schemas/{parentGUID}/schema-attributes/list")
public VoidResponse addSchemaAttributes(@PathVariable
                                                                                                                             String serverName,
                                                                                                                             @PathVariable
                                                                                                                             String userId,
                                                                                                                             @PathVariable
                                                                                                                             String assetGUID,
                                                                                                                             @PathVariable
                                                                                                                             String parentGUID,
                                                                                                                             @RequestBody
                                                                                                                             SchemaAttributesRequestBody schemaAttributes)

Adds attributes to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

parentGUID - unique identifier of the schema element to anchor these attributes to.

schemaAttributes - list of schema attribute objects.

Returns:

list of unique identifiers for the new schema attributes returned in the same order as the supplied attribute or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSchemaAttribute

@PostMapping(path="/assets/{assetGUID}/schemas/{parentGUID}/schema-attributes")
public GUIDResponse addSchemaAttribute(@PathVariable
                                                                                                                       String serverName,
                                                                                                                       @PathVariable
                                                                                                                       String userId,
                                                                                                                       @PathVariable
                                                                                                                       String assetGUID,
                                                                                                                       @PathVariable
                                                                                                                       String parentGUID,
                                                                                                                       @RequestBody
                                                                                                                       SchemaAttributeRequestBody schemaAttribute)

Adds the attribute to a complex schema type like a relational table, avro schema or a structured document. This method can be called repeatedly to add many attributes to a schema. The GUID returned can be used to add nested attributes.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

parentGUID - unique identifier of the schema element to anchor these attributes to.

schemaAttribute - schema attribute object.

Returns:

list of unique identifiers for the new schema attributes returned in the same order as the supplied attribute or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSchemaToAsset

@PostMapping(path="/assets/{assetGUID}/schema-type")
 @Deprecated
public GUIDResponse addSchemaToAsset(@PathVariable
                                                                                                       String serverName,
                                                                                                       @PathVariable
                                                                                                       String userId,
                                                                                                       @PathVariable
                                                                                                       String assetGUID,
                                                                                                       @RequestBody
                                                                                                       SchemaRequestBody requestBody)

Deprecated.

Links the supplied schema to the asset. If the schema has the GUID set, it is assumed to refer to an existing schema defined in the metadata repository. If this schema is either not found, or already attached to an asset, then an error occurs. If the GUID is null then a new schemaType is added to the metadata repository and attached to the asset. If another schema is currently attached to the asset, it is unlinked and deleted. This method is deprecated in favour of the use of Asset Owner specific request body objects that do not have the element header.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that the schema is to be attached to

requestBody - schema to attach

Returns:

guid of the schema type or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSchemaAttributesToSchema

@PostMapping(path="/schemas/{schemaTypeGUID}/schema-attributes")
 @Deprecated
public VoidResponse addSchemaAttributesToSchema(@PathVariable
                                                                                                                              String serverName,
                                                                                                                              @PathVariable
                                                                                                                              String userId,
                                                                                                                              @PathVariable
                                                                                                                              String schemaTypeGUID,
                                                                                                                              @RequestBody
                                                                                                                              List<SchemaAttribute> schemaAttributes)

Deprecated.

Adds attributes to a complex schema type like a relational table or a structured document. This method can be called repeatedly to add many attributes to a schema. It is deprecated because it does not supply the assetGUID which is needed to ensure that the caller has a right to update the attachments of the asset. With this original version of the API, the asset has to be located to validate the authorization of the user. This extra processing is unnecessary in the Asset Owner's case because the assetGUID is known.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

schemaTypeGUID - unique identifier if the schema to anchor these attributes to.

schemaAttributes - list of schema attribute objects.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addConnectionToAsset

@PostMapping(path="/assets/{assetGUID}/connection")
public VoidResponse addConnectionToAsset(@PathVariable
                                                                                             String serverName,
                                                                                             @PathVariable
                                                                                             String userId,
                                                                                             @PathVariable
                                                                                             String assetGUID,
                                                                                             @RequestBody
                                                                                             ConnectionRequestBody requestBody)

Adds a connection to an asset. Assets can have multiple connections attached.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset to attach the connection to

requestBody - request body including a summary and connection object. If the connection is already stored (matching guid) then the existing connection is used.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSemanticAssignment

@PostMapping(path="/assets/{assetGUID}/meanings/{glossaryTermGUID}")
public VoidResponse addSemanticAssignment(@PathVariable
                                                                                                               String serverName,
                                                                                                               @PathVariable
                                                                                                               String userId,
                                                                                                               @PathVariable
                                                                                                               String assetGUID,
                                                                                                               @PathVariable
                                                                                                               String glossaryTermGUID,
                                                                                                               @RequestBody(required=false)
                                                                                                               NullRequestBody requestBody)

Create a simple relationship between a glossary term and an Asset description.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that is being described

glossaryTermGUID - unique identifier of the glossary term

requestBody - null request body to satisfy POST request.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSemanticAssignment

@PostMapping(path="/assets/{assetGUID}/attachments/{assetElementGUID}/meanings/{glossaryTermGUID}")
public VoidResponse addSemanticAssignment(@PathVariable
                                                                                                                                              String serverName,
                                                                                                                                              @PathVariable
                                                                                                                                              String userId,
                                                                                                                                              @PathVariable
                                                                                                                                              String assetGUID,
                                                                                                                                              @PathVariable
                                                                                                                                              String glossaryTermGUID,
                                                                                                                                              @PathVariable
                                                                                                                                              String assetElementGUID,
                                                                                                                                              @RequestBody(required=false)
                                                                                                                                              NullRequestBody requestBody)

Create a simple relationship between a glossary term and an element in an Asset description (typically a field in the schema).

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset that is being described

glossaryTermGUID - unique identifier of the glossary term

assetElementGUID - element to link it to - its type must inherit from Referenceable.

requestBody - null request body to satisfy POST request.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

removeSemanticAssignment

@PostMapping(path="/assets/{assetGUID}/meanings/{glossaryTermGUID}/delete")
public VoidResponse removeSemanticAssignment(@PathVariable
                                                                                                                         String serverName,
                                                                                                                         @PathVariable
                                                                                                                         String userId,
                                                                                                                         @PathVariable
                                                                                                                         String assetGUID,
                                                                                                                         @PathVariable
                                                                                                                         String glossaryTermGUID,
                                                                                                                         @RequestBody(required=false)
                                                                                                                         NullRequestBody requestBody)

Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

glossaryTermGUID - unique identifier of the glossary term

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

removeSemanticAssignment

@PostMapping(path="/assets/{assetGUID}/attachments/{assetElementGUID}/meanings/{glossaryTermGUID}/delete")
public VoidResponse removeSemanticAssignment(@PathVariable
                                                                                                                                                        String serverName,
                                                                                                                                                        @PathVariable
                                                                                                                                                        String userId,
                                                                                                                                                        @PathVariable
                                                                                                                                                        String assetGUID,
                                                                                                                                                        @PathVariable
                                                                                                                                                        String glossaryTermGUID,
                                                                                                                                                        @PathVariable
                                                                                                                                                        String assetElementGUID,
                                                                                                                                                        @PathVariable(required=false)
                                                                                                                                                        NullRequestBody requestBody)

Remove the relationship between a glossary term and an element in an Asset description (typically a field in the schema).

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

glossaryTermGUID - unique identifier of the glossary term

assetElementGUID - element to link it to - its type must inherit from Referenceable.

requestBody - null request body

Returns:

void or InvalidParameterException one of the parameters is null or invalid or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addAssetOrigin

@PostMapping(path="/assets/{assetGUID}/origin")
public VoidResponse addAssetOrigin(@PathVariable
                                                                                   String serverName,
                                                                                   @PathVariable
                                                                                   String userId,
                                                                                   @PathVariable
                                                                                   String assetGUID,
                                                                                   @RequestBody
                                                                                   OriginRequestBody requestBody)

Set up the labels that classify an asset's origin.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

requestBody - Descriptive labels describing origin of the asset

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

removeAssetOrigin

@PostMapping(path="/assets/{assetGUID}/origin/delete")
public VoidResponse removeAssetOrigin(@PathVariable
                                                                                             String serverName,
                                                                                             @PathVariable
                                                                                             String userId,
                                                                                             @PathVariable
                                                                                             String assetGUID,
                                                                                             @RequestBody(required=false)
                                                                                             NullRequestBody requestBody)

Remove the asset origin classification to an asset.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

requestBody - null request body

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

updateAssetZones

@PostMapping(path="/assets/{assetGUID}/governance-zones")
public VoidResponse updateAssetZones(@PathVariable
                                                                                               String serverName,
                                                                                               @PathVariable
                                                                                               String userId,
                                                                                               @PathVariable
                                                                                               String assetGUID,
                                                                                               @RequestBody
                                                                                               List<String> assetZones)

Update the zones for a specific asset.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier for the asset to update

assetZones - list of zones for the asset - these values override the current values - null means belongs to no zones.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

updateAssetOwner

@PostMapping(path="/assets/{assetGUID}/owner")
public VoidResponse updateAssetOwner(@PathVariable
                                                                                    String serverName,
                                                                                    @PathVariable
                                                                                    String userId,
                                                                                    @PathVariable
                                                                                    String assetGUID,
                                                                                    @RequestBody
                                                                                    OwnerRequestBody requestBody)

Update the owner information for a specific asset.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier for the asset to update

requestBody - values describing the new owner

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSecurityTags

@PostMapping(path="/assets/{assetGUID}/security-tags")
public VoidResponse addSecurityTags(@PathVariable
                                                                                           String serverName,
                                                                                           @PathVariable
                                                                                           String userId,
                                                                                           @PathVariable
                                                                                           String assetGUID,
                                                                                           @RequestBody
                                                                                           SecurityTagsRequestBody requestBody)

Add or replace the security tags for an asset or one of its elements.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

requestBody - list of security labels and properties

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

addSecurityTags

@PostMapping(path="/assets/{assetGUID}/attachments/{assetElementGUID}/security-tags")
public VoidResponse addSecurityTags(@PathVariable
                                                                                                                          String serverName,
                                                                                                                          @PathVariable
                                                                                                                          String userId,
                                                                                                                          @PathVariable
                                                                                                                          String assetGUID,
                                                                                                                          @PathVariable
                                                                                                                          String assetElementGUID,
                                                                                                                          @RequestBody
                                                                                                                          SecurityTagsRequestBody requestBody)

Add or replace the security tags for an asset or one of its elements.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

assetElementGUID - element to link it to - its type must inherit from Referenceable.

requestBody - list of security labels and properties

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

removeSecurityTags

@PostMapping(path="/assets/{assetGUID}/security-tags/delete")
public VoidResponse removeSecurityTags(@PathVariable
                                                                                                     String serverName,
                                                                                                     @PathVariable
                                                                                                     String userId,
                                                                                                     @PathVariable
                                                                                                     String assetGUID,
                                                                                                     @RequestBody(required=false)
                                                                                                     NullRequestBody requestBody)

Remove the security tags classification from an asset.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

requestBody - null request body

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

removeSecurityTags

@PostMapping(path="/assets/{assetGUID}/attachments/{assetElementGUID}/security-tags/delete")
public VoidResponse removeSecurityTags(@PathVariable
                                                                                                                                    String serverName,
                                                                                                                                    @PathVariable
                                                                                                                                    String userId,
                                                                                                                                    @PathVariable
                                                                                                                                    String assetGUID,
                                                                                                                                    @PathVariable
                                                                                                                                    String assetElementGUID,
                                                                                                                                    @RequestBody(required=false)
                                                                                                                                    NullRequestBody requestBody)

Remove the security tags classification to one of an asset's elements.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of asset

assetElementGUID - element where the security tags need to be removed.

requestBody - null request body

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getAssetsByName

@PostMapping(path="/assets/by-name")
public AssetsResponse getAssetsByName(@PathVariable
                                                                           String serverName,
                                                                           @PathVariable
                                                                           String userId,
                                                                           @RequestParam
                                                                           int startFrom,
                                                                           @RequestParam
                                                                           int pageSize,
                                                                           @RequestBody
                                                                           String name)

Return a list of assets with the requested name.

Parameters:

serverName - name of the server instances for this request

userId - calling user

name - name to search for

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of Asset summaries or InvalidParameterException the name is invalid or PropertyServerException there is a problem access in the property server or UserNotAuthorizedException the user does not have access to the properties

findAssets

@PostMapping(path="/assets/by-search-string")
public AssetsResponse findAssets(@PathVariable
                                                                               String serverName,
                                                                               @PathVariable
                                                                               String userId,
                                                                               @RequestParam
                                                                               int startFrom,
                                                                               @RequestParam
                                                                               int pageSize,
                                                                               @RequestBody
                                                                               String searchString)

Return a list of assets with the requested search string in their name, qualified name or description.

Parameters:

serverName - name of the server instances for this request

userId - calling user

searchString - string to search for in text

startFrom - starting element (used in paging through large result sets)

pageSize - maximum number of results to return

Returns:

list of assets that match the search string or InvalidParameterException the searchString is invalid or PropertyServerException there is a problem access in the property server or UserNotAuthorizedException the user does not have access to the properties

getDiscoveryAnalysisReports

@GetMapping(path="/assets/{assetGUID}/discovery-analysis-reports")
public DiscoveryAnalysisReportListResponse getDiscoveryAnalysisReports(@PathVariable
                                                                                                                                          String serverName,
                                                                                                                                          @PathVariable
                                                                                                                                          String userId,
                                                                                                                                          @PathVariable
                                                                                                                                          String assetGUID,
                                                                                                                                          @RequestParam
                                                                                                                                          int startingFrom,
                                                                                                                                          @RequestParam
                                                                                                                                          int maximumResults)

Return the discovery analysis reports about the asset.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the asset

startingFrom - position in the list (used when there are so many reports that paging is needed

maximumResults - maximum number of elements to return an this call

Returns:

list of discovery analysis reports or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getDiscoveryReportAnnotations

@GetMapping(path="/discovery-analysis-reports/{discoveryReportGUID}/annotations")
public AnnotationListResponse getDiscoveryReportAnnotations(@PathVariable
                                                                                                                                              String serverName,
                                                                                                                                              @PathVariable
                                                                                                                                              String userId,
                                                                                                                                              @PathVariable
                                                                                                                                              String discoveryReportGUID,
                                                                                                                                              @RequestParam
                                                                                                                                              int startingFrom,
                                                                                                                                              @RequestParam
                                                                                                                                              int maximumResults,
                                                                                                                                              @RequestBody
                                                                                                                                              StatusRequestBody requestBody)

Return the annotations linked directly to the report.

Parameters:

serverName - name of the server instance to connect to

userId - identifier of calling user

discoveryReportGUID - identifier of the discovery request.

startingFrom - initial position in the stored list.

maximumResults - maximum number of definitions to return on this call.

requestBody - status of the desired annotations - null means all statuses.

Returns:

list of annotations or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

getExtendedAnnotations

@GetMapping(path="/annotations/{annotationGUID}/annotations")
public AnnotationListResponse getExtendedAnnotations(@PathVariable
                                                                                                                   String serverName,
                                                                                                                   @PathVariable
                                                                                                                   String userId,
                                                                                                                   @PathVariable
                                                                                                                   String annotationGUID,
                                                                                                                   @RequestParam
                                                                                                                   int startingFrom,
                                                                                                                   @RequestParam
                                                                                                                   int maximumResults,
                                                                                                                   @RequestBody
                                                                                                                   StatusRequestBody requestBody)

Return any annotations attached to this annotation.

Parameters:

serverName - name of the server instance to connect to

userId - identifier of calling user

annotationGUID - anchor annotation

startingFrom - starting position in the list

maximumResults - maximum number of annotations that can be returned.

requestBody - status of the desired annotations - null means all statuses.

Returns:

list of Annotation objects or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem

deleteAsset

@PostMapping(path="/assets/{assetGUID}/delete")
public VoidResponse deleteAsset(@PathVariable
                                                                                String serverName,
                                                                                @PathVariable
                                                                                String userId,
                                                                                @PathVariable
                                                                                String assetGUID,
                                                                                @RequestBody(required=false)
                                                                                NullRequestBody requestBody)

Deletes an asset and all of its associated elements such as schema, connections (unless they are linked to another asset), discovery reports and associated feedback. Given the depth of the delete performed by this call, it should be used with care.

Parameters:

serverName - name of the server instance to connect to

userId - calling user

assetGUID - unique identifier of the attest to attach the connection to

requestBody - dummy request body to satisfy POST protocol.

Returns:

void or InvalidParameterException full path or userId is null or PropertyServerException problem accessing property server or UserNotAuthorizedException security access problem