Class CollectionManagerResource
java.lang.Object
org.odpi.openmetadata.viewservices.collectionmanager.server.spring.CollectionManagerResource
@RestController
@RequestMapping("/servers/{serverName}/api/open-metadata/{urlMarker}")
public class CollectionManagerResource
extends Object
The CollectionManagerResource provides the Spring API endpoints of the Collection Manager Open Metadata View Service (OMVS).
=
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddToCollection
(String serverName, String urlMarker, String collectionGUID, String elementGUID, NewRelationshipRequestBody requestBody) Add an element to a collection.attachCollection
(String serverName, String urlMarker, String collectionGUID, String parentGUID, NewRelationshipRequestBody requestBody) Connect an existing collection to an element using the ResourceList relationship (0019).clearEditingCollection
(String serverName, String urlMarker, String collectionGUID, MetadataSourceRequestBody requestBody) Remove the editing collection designation from the collection.clearScopingCollection
(String serverName, String urlMarker, String collectionGUID, MetadataSourceRequestBody requestBody) Remove the scoping collection designation from the collection.clearStagingCollection
(String serverName, String urlMarker, String collectionGUID, MetadataSourceRequestBody requestBody) Remove the staging collection designation from the collection.createCollection
(String serverName, String urlMarker, NewElementRequestBody requestBody) Create a new generic collection.createCollectionFromTemplate
(String serverName, String urlMarker, TemplateRequestBody requestBody) Create a new metadata element to represent a collection using an existing metadata element as a template.deleteCollection
(String serverName, String urlMarker, String collectionGUID, DeleteRequestBody requestBody) Delete a collection.detachAgreementActor
(String serverName, String urlMarker, String agreementActorRelationshipGUID, DeleteRequestBody requestBody) Detach an actor from an agreement.detachAgreementItem
(String serverName, String urlMarker, String agreementGUID, String agreementItemGUID, DeleteRequestBody requestBody) Detach an agreement from an element involved in its definition.detachCollection
(String serverName, String urlMarker, String collectionGUID, String parentGUID, DeleteRequestBody requestBody) Detach an existing collection from an element.detachContract
(String serverName, String urlMarker, String agreementGUID, String externalReferenceGUID, DeleteRequestBody requestBody) Detach an agreement from an external reference describing the location of the contract documents.detachDigitalProductDependency
(String serverName, String urlMarker, String consumerDigitalProductGUID, String consumedDigitalProductGUID, DeleteRequestBody requestBody) Unlink dependent digital products.detachProductManager
(String serverName, String urlMarker, String digitalProductGUID, String digitalProductManagerRoleGUID, DeleteRequestBody requestBody) Detach a product manager from a digital product.detachSubscriber
(String serverName, String urlMarker, String digitalSubscriberGUID, String digitalSubscriptionGUID, DeleteRequestBody requestBody) Detach a subscriber from a subscription.findCollections
(String serverName, String urlMarker, SearchStringRequestBody requestBody) Returns the list of collections matching the search string.getAttachedCollections
(String serverName, String urlMarker, String parentGUID, ResultsRequestBody requestBody) Returns the list of collections that are linked off of the supplied element.getCollectionByGUID
(String serverName, String urlMarker, String collectionGUID, GetRequestBody requestBody) Return the properties of a specific collection.getCollectionHierarchy
(String serverName, String urlMarker, String collectionGUID, ResultsRequestBody requestBody) Return a hierarchy of nested collections.getCollectionMembers
(String serverName, String urlMarker, String collectionGUID, ResultsRequestBody requestBody) Return a list of elements that are a member of a collection.getCollectionsByName
(String serverName, String urlMarker, FilterRequestBody requestBody) Returns the list of collections with a particular name.getCollectionsByType
(String serverName, String urlMarker, FilterRequestBody requestBody) Returns the list of collections with a particular collectionType.linkAgreementActor
(String serverName, String urlMarker, String agreementGUID, String actorGUID, NewRelationshipRequestBody requestBody) Attach an actor to an agreement.linkAgreementItem
(String serverName, String urlMarker, String agreementGUID, String agreementItemGUID, NewRelationshipRequestBody requestBody) Attach an agreement to an element referenced in its definition.linkContract
(String serverName, String urlMarker, String agreementGUID, String externalReferenceGUID, NewRelationshipRequestBody requestBody) Attach an agreement to an external reference element that describes the location of the contract documents.linkDigitalProductDependency
(String serverName, String urlMarker, String consumerDigitalProductGUID, String consumedDigitalProductGUID, NewRelationshipRequestBody requestBody) Link two dependent digital products.linkProductManager
(String serverName, String urlMarker, String digitalProductGUID, String digitalProductManagerRoleGUID, NewRelationshipRequestBody requestBody) Attach a product manager to a digital product.linkSubscriber
(String serverName, String urlMarker, String digitalSubscriberGUID, String digitalSubscriptionGUID, NewRelationshipRequestBody requestBody) Attach a subscriber to a subscription.removeFromCollection
(String serverName, String urlMarker, String collectionGUID, String elementGUID, DeleteRequestBody requestBody) Remove an element from a collection.setEditingCollection
(String serverName, String urlMarker, String collectionGUID, NewClassificationRequestBody requestBody) Classify the collection to indicate that it is an editing collection - this means it is a collection of element updates that will be merged into its source collection.setScopingCollection
(String serverName, String urlMarker, String collectionGUID, NewClassificationRequestBody requestBody) Classify the collection to indicate that it is a scoping collection - this means it is a collection of elements that are being considered for inclusion in a project or activity.setStagingCollection
(String serverName, String urlMarker, String collectionGUID, NewClassificationRequestBody requestBody) Classify the collection to indicate that it is a staging collection - this means it is a collection of element updates that will be transferred into another collectionupdateCollection
(String serverName, String urlMarker, String collectionGUID, UpdateElementRequestBody requestBody) Update the properties of a collection.updateCollectionMembership
(String serverName, String urlMarker, String collectionGUID, String elementGUID, UpdateRelationshipRequestBody requestBody) Update an element's membership to a collection.
-
Constructor Details
-
CollectionManagerResource
public CollectionManagerResource()Default constructor
-
-
Method Details
-
getAttachedCollections
@PostMapping(path="/metadata-elements/{parentGUID}/collections") public OpenMetadataRootElementsResponse getAttachedCollections(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String parentGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Returns the list of collections that are linked off of the supplied element.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerparentGUID
- unique identifier of referenceable object (typically a personal profile, project or community) that the collections hang off ofrequestBody
- filter response by collection type - if null, any value will do- Returns:
- a list of collections InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
findCollections
@PostMapping(path="/collections/by-search-string") public OpenMetadataRootElementsResponse findCollections(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) SearchStringRequestBody requestBody) Returns the list of collections matching the search string.- Parameters:
serverName
- name of the service to route the request tourlMarker
- view service URL markerrequestBody
- string to find in the properties- Returns:
- a list of collections InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getCollectionsByName
@PostMapping(path="/collections/by-name") public OpenMetadataRootElementsResponse getCollectionsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody) Returns the list of collections with a particular name.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerrequestBody
- name of the collections to return - match is full text match in qualifiedName or name- Returns:
- a list of collections InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getCollectionsByType
@PostMapping(path="/collections/by-collection-category") public OpenMetadataRootElementsResponse getCollectionsByType(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) FilterRequestBody requestBody) Returns the list of collections with a particular collectionType. This is an optional text field in the collection element.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerrequestBody
- the collection type value to match on. If it is null, all collections with a null collectionType are returned- Returns:
- a list of collections InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getCollectionByGUID
@PostMapping(path="/collections/{collectionGUID}/retrieve") public OpenMetadataRootElementResponse getCollectionByGUID(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) GetRequestBody requestBody) Return the properties of a specific collection.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markercollectionGUID
- unique identifier of the required collection- Returns:
- collection properties InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
createCollection
@PostMapping(path="/collections") public GUIDResponse createCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) NewElementRequestBody requestBody) Create a new generic collection.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markerrequestBody
- properties for the collection.- Returns:
- unique identifier of the newly created Collection InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
createCollectionFromTemplate
@PostMapping(path="/collections/from-template") public GUIDResponse createCollectionFromTemplate(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) TemplateRequestBody requestBody) Create a new metadata element to represent a collection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new collection.- Parameters:
serverName
- calling userurlMarker
- view service URL markerrequestBody
- properties that override the template- Returns:
- unique identifier of the new metadata element InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
updateCollection
@PostMapping(path="/collections/{collectionGUID}/update") public VoidResponse updateCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) UpdateElementRequestBody requestBody) Update the properties of a collection.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markercollectionGUID
- unique identifier of the collection (returned from create)requestBody
- properties for the collection.- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
attachCollection
@PostMapping(path="/metadata-elements/{parentGUID}/collections/{collectionGUID}/attach") public VoidResponse attachCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @PathVariable String parentGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Connect an existing collection to an element using the ResourceList relationship (0019).- Parameters:
serverName
- name of called serverurlMarker
- view service URL markercollectionGUID
- unique identifier of the collectionparentGUID
- unique identifier of referenceable object that the collection should be attached torequestBody
- description of how the collection will be used.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachCollection
@PostMapping(path="/metadata-elements/{parentGUID}/collections/{collectionGUID}/detach") public VoidResponse detachCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @PathVariable String parentGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach an existing collection from an element. If the collection is anchored to the element, it is deleted.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markercollectionGUID
- unique identifier of the collection.parentGUID
- unique identifier of referenceable object that the collection should be attached to.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkDigitalProductDependency
@PostMapping(path="/collections/digital-products/{consumerDigitalProductGUID}/product-dependencies/{consumedDigitalProductGUID}/attach") public VoidResponse linkDigitalProductDependency(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String consumerDigitalProductGUID, @PathVariable String consumedDigitalProductGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Link two dependent digital products.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerconsumerDigitalProductGUID
- unique identifier of the digital product that has the dependency.consumedDigitalProductGUID
- unique identifier of the digital product that it is using.requestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachDigitalProductDependency
@PostMapping(path="/collections/digital-products/{consumerDigitalProductGUID}/product-dependencies/{consumedDigitalProductGUID}/detach") public VoidResponse detachDigitalProductDependency(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String consumerDigitalProductGUID, @PathVariable String consumedDigitalProductGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Unlink dependent digital products.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerconsumerDigitalProductGUID
- unique identifier of the digital product that has the dependency.consumedDigitalProductGUID
- unique identifier of the digital product that it is using.requestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkSubscriber
@PostMapping(path="/collections/subscribers/{digitalSubscriberGUID}/subscriptions/{digitalSubscriptionGUID}/attach") public VoidResponse linkSubscriber(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String digitalSubscriberGUID, @PathVariable String digitalSubscriptionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach a subscriber to a subscription.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerdigitalSubscriberGUID
- unique identifier of the subscriber (referenceable)digitalSubscriptionGUID
- unique identifier of the digital subscription agreementrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachSubscriber
@PostMapping(path="/subscribers/{digitalSubscriberGUID}/subscriptions/{digitalSubscriptionGUID}/detach") public VoidResponse detachSubscriber(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String digitalSubscriberGUID, @PathVariable String digitalSubscriptionGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach a subscriber from a subscription.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerdigitalSubscriberGUID
- unique identifier of the subscriber (referenceable)digitalSubscriptionGUID
- unique identifier of the digital subscription agreementrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkProductManager
@PostMapping(path="/collections/digital-products/{digitalProductGUID}/product-managers/{digitalProductManagerRoleGUID}/attach") public VoidResponse linkProductManager(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String digitalProductGUID, @PathVariable String digitalProductManagerRoleGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach a product manager to a digital product.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerdigitalProductGUID
- unique identifier of the digital productdigitalProductManagerRoleGUID
- unique identifier of the product manager rolerequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachProductManager
@PostMapping(path="/collection/digital-products/{digitalProductGUID}/product-managers/{digitalProductManagerRoleGUID}/detach") public VoidResponse detachProductManager(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String digitalProductGUID, @PathVariable String digitalProductManagerRoleGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach a product manager from a digital product.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markerdigitalProductGUID
- unique identifier of the digital productdigitalProductManagerRoleGUID
- unique identifier of the product manager rolerequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkAgreementActor
@PostMapping(path="/collections/agreements/{agreementGUID}/agreement-actors/{actorGUID}/attach") public GUIDResponse linkAgreementActor(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementGUID, @PathVariable String actorGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach an actor to an agreement.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeragreementGUID
- unique identifier of the agreementactorGUID
- unique identifier of the actorrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachAgreementActor
@PostMapping(path="/collection/agreements/agreement-actors/{agreementActorRelationshipGUID}/detach") public VoidResponse detachAgreementActor(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementActorRelationshipGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach an actor from an agreement.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeragreementActorRelationshipGUID
- unique identifier of the element being describedrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkAgreementItem
@PostMapping(path="/collections/agreements/{agreementGUID}/agreement-items/{agreementItemGUID}/attach") public VoidResponse linkAgreementItem(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementGUID, @PathVariable String agreementItemGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach an agreement to an element referenced in its definition.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeragreementGUID
- unique identifier of the agreementagreementItemGUID
- unique identifier of the agreement itemrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachAgreementItem
@PostMapping(path="/collections/agreements/{agreementGUID}/agreement-items/{agreementItemGUID}/detach") public VoidResponse detachAgreementItem(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementGUID, @PathVariable String agreementItemGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach an agreement from an element involved in its definition.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeragreementGUID
- unique identifier of the agreementagreementItemGUID
- unique identifier of the agreement itemrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
linkContract
@PostMapping(path="/collections/agreements/{agreementGUID}/contract-links/{externalReferenceGUID}/attach") public VoidResponse linkContract(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Attach an agreement to an external reference element that describes the location of the contract documents.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeragreementGUID
- unique identifier of the agreementexternalReferenceGUID
- unique identifier of the external reference describing the location of the contractrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
detachContract
@PostMapping(path="/collections/agreements/{agreementGUID}/contract-links/{externalReferenceGUID}/detach") public VoidResponse detachContract(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Detach an agreement from an external reference describing the location of the contract documents.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markeragreementGUID
- unique identifier of the agreementexternalReferenceGUID
- unique identifier of the external reference describing the location of the contractrequestBody
- description of the relationship.- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
setEditingCollection
@PostMapping(path="/collections/{collectionGUID}/is-editing-collection") public VoidResponse setEditingCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody NewClassificationRequestBody requestBody) Classify the collection to indicate that it is an editing collection - this means it is a collection of element updates that will be merged into its source collection.- Parameters:
serverName
- name of the server to route the request tourlMarker
- view service URL markercollectionGUID
- unique identifier of the metadata element to classifyrequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearEditingCollection
@PostMapping(path="/collections/{collectionGUID}/is-editing-collection/delete") public VoidResponse clearEditingCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Remove the editing collection designation from the collection.- Parameters:
serverName
- name of the server to route the request tourlMarker
- view service URL markercollectionGUID
- unique identifier of the metadata element to declassifyrequestBody
- correlation properties for the external asset manager- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setScopingCollection
@PostMapping(path="/collections/{collectionGUID}/is-scoping-collection") public VoidResponse setScopingCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody NewClassificationRequestBody requestBody) Classify the collection to indicate that it is a scoping collection - this means it is a collection of elements that are being considered for inclusion in a project or activity.- Parameters:
serverName
- name of the server to route the request tourlMarker
- view service URL markercollectionGUID
- unique identifier of the metadata element to classifyrequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearScopingCollection
@PostMapping(path="/collections/{collectionGUID}/is-scoping-collection/delete") public VoidResponse clearScopingCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Remove the scoping collection designation from the collection.- Parameters:
serverName
- name of the server to route the request tourlMarker
- view service URL markercollectionGUID
- unique identifier of the metadata element to declassifyrequestBody
- correlation properties for the external asset manager- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
setStagingCollection
@PostMapping(path="/collections/{collectionGUID}/is-staging-collection") public VoidResponse setStagingCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody NewClassificationRequestBody requestBody) Classify the collection to indicate that it is a staging collection - this means it is a collection of element updates that will be transferred into another collection- Parameters:
serverName
- name of the server to route the request tourlMarker
- view service URL markercollectionGUID
- unique identifier of the metadata element to classifyrequestBody
- properties to help with the mapping of the elements in the external asset manager and open metadata- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
clearStagingCollection
@PostMapping(path="/collections/{collectionGUID}/is-staging-collection/delete") public VoidResponse clearStagingCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody) Remove the staging collection designation from the collection.- Parameters:
serverName
- name of the server to route the request tourlMarker
- view service URL markercollectionGUID
- unique identifier of the metadata element to declassifyrequestBody
- correlation properties for the external asset manager- Returns:
- void or InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException there is a problem reported in the open metadata server(s)
-
deleteCollection
@PostMapping(path="/collections/{collectionGUID}/delete") public VoidResponse deleteCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) DeleteRequestBody requestBody) Delete a collection. It is detected from all parent elements. If members are anchored to the collection then they are also deleted.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markercollectionGUID
- unique identifier of the collection.requestBody
- delete options- Returns:
- void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getCollectionMembers
@PostMapping(path="/collections/{collectionGUID}/members") public OpenMetadataRootElementsResponse getCollectionMembers(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Return a list of elements that are a member of a collection.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markercollectionGUID
- unique identifier of the collection.- Returns:
- list of collection details InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
getCollectionHierarchy
@PostMapping(path="/collections/{collectionGUID}/hierarchy") public OpenMetadataRootElementResponse getCollectionHierarchy(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) ResultsRequestBody requestBody) Return a hierarchy of nested collections.- Parameters:
serverName
- name of called serverurlMarker
- view service URL markercollectionGUID
- unique identifier of the collectionrequestBody
- additional properties for the search- Returns:
- graph of collection details InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
addToCollection
@PostMapping(path="/collections/{collectionGUID}/members/{elementGUID}/attach") public VoidResponse addToCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @PathVariable String elementGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody) Add an element to a collection.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markercollectionGUID
- unique identifier of the collection.requestBody
- properties describing the membership characteristics.elementGUID
- unique identifier of the element.- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem updating information in the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
updateCollectionMembership
@PostMapping(path="/collections/{collectionGUID}/members/{elementGUID}/update") public VoidResponse updateCollectionMembership(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @PathVariable String elementGUID, @RequestBody(required=false) UpdateRelationshipRequestBody requestBody) Update an element's membership to a collection.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markercollectionGUID
- unique identifier of the collection.requestBody
- properties describing the membership characteristics.elementGUID
- unique identifier of the element.- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem updating information in the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-
removeFromCollection
@PostMapping(path="/collections/{collectionGUID}/members/{elementGUID}/detach") public VoidResponse removeFromCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @PathVariable String elementGUID, @RequestBody DeleteRequestBody requestBody) Remove an element from a collection.- Parameters:
serverName
- name of called server.urlMarker
- view service URL markercollectionGUID
- unique identifier of the collection.elementGUID
- unique identifier of the element.requestBody
- null request body- Returns:
- void or InvalidParameterException one of the parameters is invalid. PropertyServerException there is a problem updating information in the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.
-