Package org.odpi.openmetadata.viewservices.collectionmanager.server.spring

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 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 server
      urlMarker - view service URL marker
      parentGUID - unique identifier of referenceable object (typically a personal profile, project or community) that the collections hang off of
      requestBody - 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 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 to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of collections InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • findDigitalProducts

      @PostMapping(path="/digital-products/by-search-string") public OpenMetadataRootElementsResponse findDigitalProducts(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) DeploymentStatusSearchString requestBody)
      Returns the list of digital products matching the search string and optional deployment status. (Use findAuthoredElements() in Classification Explorer for retrieving by content status.)
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of digital products InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getDigitalProductByCategory

      @PostMapping(path="/digital-products/by-category") public OpenMetadataRootElementsResponse getDigitalProductByCategory(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody(required=false) DeploymentStatusFilterRequestBody requestBody)
      Returns the list of digital products matching the category and optional deployment status. (Use getAuthoredElementsByCategory() in Classification Explorer for retrieving by content status.)
      Parameters:
      serverName - name of the service to route the request to
      urlMarker - view service URL marker
      requestBody - string to find in the properties
      Returns:
      a list of digital products InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 server
      urlMarker - view service URL marker
      requestBody - 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 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 server
      urlMarker - view service URL marker
      requestBody - 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 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 server
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the required collection
      Returns:
      collection properties InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 marker
      requestBody - properties for the collection.
      Returns:
      unique identifier of the newly created Collection InvalidParameterException one of the parameters is invalid. PropertyServerException 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 user
      urlMarker - view service URL marker
      requestBody - 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 a problem reported in the open metadata server(s)

    • updateCollection

      @PostMapping(path="/collections/{collectionGUID}/update") public BooleanResponse 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 marker
      collectionGUID - unique identifier of the collection (returned from create)
      requestBody - properties for the collection.
      Returns:
      void or InvalidParameterException one of the parameters is invalid. PropertyServerException 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 parentGUID, @PathVariable String collectionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect an existing collection to an element using the ResourceList relationship (0019).
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the collection
      parentGUID - unique identifier of referenceable object that the collection should be attached to
      requestBody - description of how the collection will be used.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 parentGUID, @PathVariable String collectionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody 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 marker
      collectionGUID - 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • attachDataDescription

      @PostMapping(path="/metadata-elements/{parentGUID}/data-descriptions/{collectionGUID}/attach") public VoidResponse attachDataDescription(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String parentGUID, @PathVariable String collectionGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect an existing collection to an element using the ResourceList relationship (0019).
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the collection
      parentGUID - unique identifier of referenceable object that the collection should be attached to
      requestBody - description of how the collection will be used.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachDataDescription

      @PostMapping(path="/metadata-elements/{parentGUID}/data-descriptions/{collectionGUID}/detach") public VoidResponse detachDataDescription(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String parentGUID, @PathVariable String collectionGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach an existing data describing 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 marker
      collectionGUID - 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 a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • attachSmartQuery

      @PostMapping(path="/collections/results-sets/{resultsSetGUID}/smart-query/{savedQueryGUID}/attach") public VoidResponse attachSmartQuery(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String resultsSetGUID, @PathVariable String savedQueryGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect a results set to the saved query that determines its membership using the SmartQuery relationship (0725).
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      resultsSetGUID - unique identifier of the results set
      savedQueryGUID - unique identifier of the saved query that determines the results set's membership
      requestBody - description of how the saved query is used.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachSmartQuery

      @PostMapping(path="/collections/results-sets/{resultsSetGUID}/smart-query/{savedQueryGUID}/detach") public VoidResponse detachSmartQuery(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String resultsSetGUID, @PathVariable String savedQueryGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach a results set from the saved query that determines its membership.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      resultsSetGUID - unique identifier of the results set.
      savedQueryGUID - unique identifier of the saved query that determines the results set's membership.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • attachAssociatedSkillSet

      @PostMapping(path="/actors/{actorGUID}/associated-skill-sets/{skillSetGUID}/attach") public VoidResponse attachAssociatedSkillSet(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorGUID, @PathVariable String skillSetGUID, @RequestBody(required=false) NewRelationshipRequestBody requestBody)
      Connect an existing skill set collection to an actor using the AssociatedSkillSet relationship (0145).
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      skillSetGUID - unique identifier of the collection
      actorGUID - unique identifier of referenceable object that the collection should be attached to
      requestBody - description of how the collection will be used.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • detachAssociatedSkillSet

      @PostMapping(path="/actors/{actorGUID}/associated-skill-sets/{skillSetGUID}/detach") public VoidResponse detachAssociatedSkillSet(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String actorGUID, @PathVariable String skillSetGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Detach an existing skill set collection from an actor. If the collection is anchored to the element, it is deleted.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      skillSetGUID - unique identifier of the collection.
      actorGUID - unique identifier of an actor object that the collection should be attached to.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • linkSubscriber

      @PostMapping(path="/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 server
      urlMarker - view service URL marker
      digitalSubscriberGUID - unique identifier of the subscriber (referenceable)
      digitalSubscriptionGUID - unique identifier of the digital subscription agreement
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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) DeleteRelationshipRequestBody requestBody)
      Detach a subscriber from a subscription.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      digitalSubscriberGUID - unique identifier of the subscriber (referenceable)
      digitalSubscriptionGUID - unique identifier of the digital subscription agreement
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 server
      urlMarker - view service URL marker
      agreementGUID - unique identifier of the agreement
      actorGUID - unique identifier of the actor
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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) DeleteRelationshipRequestBody requestBody)
      Detach an actor from an agreement.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      agreementActorRelationshipGUID - unique identifier of the element being described
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 GUIDResponse 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 server
      urlMarker - view service URL marker
      agreementGUID - unique identifier of the agreement
      agreementItemGUID - unique identifier of the agreement item
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • updateAgreementItem

      @PostMapping(path="/agreement-items/{agreementItemRelationshipGUID}/update") public VoidResponse updateAgreementItem(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementItemRelationshipGUID, @RequestBody(required=false) UpdateRelationshipRequestBody requestBody)
      Update the properties of a agreement item relationship.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      agreementItemRelationshipGUID - unique identifier of the relationship
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • detachAgreementItem

      @PostMapping(path="/agreement-items/{agreementItemRelationshipGUID}/detach") public VoidResponse detachAgreementItem(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementItemRelationshipGUID, @RequestBody(required=false) DeleteRelationshipRequestBody requestBody)
      Remove a agreement item relationship.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      agreementItemRelationshipGUID - unique identifier of the relationship
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • 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 server
      urlMarker - view service URL marker
      agreementGUID - unique identifier of the agreement
      externalReferenceGUID - unique identifier of the external reference describing the location of the contract
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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) DeleteRelationshipRequestBody requestBody)
      Detach an agreement from an external reference describing the location of the contract documents.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      agreementGUID - unique identifier of the agreement
      externalReferenceGUID - unique identifier of the external reference describing the location of the contract
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 to
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the metadata element to classify
      requestBody - 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 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 to
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the metadata element to declassify
      requestBody - 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 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 to
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the metadata element to classify
      requestBody - 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 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 to
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the metadata element to declassify
      requestBody - 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 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 to
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the metadata element to classify
      requestBody - 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 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 to
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the metadata element to declassify
      requestBody - 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 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) DeleteElementRequestBody 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 marker
      collectionGUID - unique identifier of the collection.
      requestBody - delete options
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException 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 marker
      collectionGUID - unique identifier of the collection.
      Returns:
      list of collection details InvalidParameterException one of the parameters is invalid. PropertyServerException 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 server
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the collection
      requestBody - additional properties for the search
      Returns:
      graph of collection details InvalidParameterException one of the parameters is invalid. PropertyServerException 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 marker
      collectionGUID - 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 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 marker
      collectionGUID - 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 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(required=false) DeleteRelationshipRequestBody requestBody)
      Remove an element from a collection.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      collectionGUID - 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 a problem updating information in 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) DeleteRelationshipRequestBody requestBody)
      Detach an agreement from an element involved in its definition.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      agreementGUID - unique identifier of the agreement
      agreementItemGUID - unique identifier of the agreement item
      requestBody - description of the relationship.
      Returns:
      void or InvalidParameterException one of the parameters is null or invalid. PropertyServerException a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request. This is a multi-link relationship, so this request removes every agreement item relationship between the two elements. Use the request that takes the relationship's own unique identifier to remove just one of them.

    • setCollectionKind

      @PostMapping(path="/collections/{collectionGUID}/collection-kind") public VoidResponse setCollectionKind(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) NewClassificationRequestBody requestBody)
      Classify a collection to describe the kind of collection that it is.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the collection
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)

    • clearCollectionKind

      @PostMapping(path="/collections/{collectionGUID}/collection-kind/remove") public VoidResponse clearCollectionKind(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody(required=false) DeleteClassificationRequestBody requestBody)
      Remove the collection kind classification from a collection.
      Parameters:
      serverName - name of the server to route the request to
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the collection
      requestBody - properties for the request
      Returns:
      response object InvalidParameterException one of the parameters is invalid UserNotAuthorizedException the user is not authorized to issue this request PropertyServerException a problem reported in the open metadata server(s)