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 CollectionsResponse getAttachedCollections(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String parentGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody 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
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      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 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 CollectionsResponse findCollections(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String classificationName, @RequestParam(required=false,defaultValue="false") boolean startsWith, @RequestParam(required=false,defaultValue="false") boolean endsWith, @RequestParam(required=false,defaultValue="false") boolean ignoreCase, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) FilterRequestBody 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
      classificationName - option name of a collection classification
      startsWith - does the value start with the supplied string?
      endsWith - does the value end with the supplied string?
      ignoreCase - should the search ignore case?
      startFrom - paging start point
      pageSize - maximum results that can be returned
      requestBody - 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 CollectionsResponse getCollectionsByName(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String classificationName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody FilterRequestBody requestBody)
      Returns the list of collections with a particular name.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      classificationName - option name of a collection classification
      requestBody - name of the collections to return - match is full text match in qualifiedName or name
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      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-type") public CollectionsResponse getCollectionsByType(@PathVariable String serverName, @PathVariable String urlMarker, @RequestParam(required=false) String classificationName, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @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
      classificationName - option name of a collection classification
      requestBody - the collection type value to match on. If it is null, all collections with a null collectionType are returned
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      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.

    • getCollection

      @GetMapping(path="/collections/{collectionGUID}") public CollectionResponse getCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID)
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • getCollection

      @PostMapping(path="/collections/{collectionGUID}") public CollectionResponse getCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestBody AnyTimeRequestBody 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 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, @RequestParam(required=false) String classificationName, @RequestBody NewElementRequestBody requestBody)
      Create a new generic collection.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      classificationName - name of collection classification
      requestBody - 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.

    • createRootCollection

      @PostMapping(path="/collections/root-collection") public GUIDResponse createRootCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new collection with the RootCollection classification. Used to identify the top of a collection hierarchy.
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createDataSpecCollection

      @PostMapping(path="/collections/data-spec-collection") public GUIDResponse createDataSpecCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new collection with the DataSpec classification. Used to identify a collection of data structures and data fields used to define data requirements for a project or initiative.
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createDataDictionaryCollection

      @PostMapping(path="/collections/data-dictionary-collection") public GUIDResponse createDataDictionaryCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new collection with the Data Dictionary classification. Used to identify a collection of data fields that represent a data store of collection of common data types.
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createFolderCollection

      @PostMapping(path="/collections/folder") public GUIDResponse createFolderCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new collection with the Folder classification. This is used to identify the organizing collections in a collection hierarchy.
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createContextEventCollection

      @PostMapping(path="/collections/context-event-collection") public GUIDResponse createContextEventCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new collection with the ContextEventCollection classification.
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createNamespaceCollection

      @PostMapping(path="/collections/namespace-collection") public GUIDResponse createNamespaceCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new collection with the Namespace classification. This is used to group elements that belong to the same namespace.
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createDataSharingAgreement

      @PostMapping(path="/collections/data-sharing-agreement") public GUIDResponse createDataSharingAgreement(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new agreement with the DataSharingAgreement classification. This is used to identify an agreement as being related to the sharing of data between two parties. *
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createEventSetCollection

      @PostMapping(path="/collections/event-set-collection") public GUIDResponse createEventSetCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new collection with the EventSet classification.
      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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • createNamingStandardRuleSetCollection

      @PostMapping(path="/collections/naming-standard-rule-set-collection") public GUIDResponse createNamingStandardRuleSetCollection(@PathVariable String serverName, @PathVariable String urlMarker, @RequestBody NewElementRequestBody requestBody)
      Create a new collection with the NamingStandardRuleSet classification.
      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 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 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 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, @RequestParam boolean replaceAllProperties, @RequestBody 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)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      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.

    • updateDigitalProductStatus

      @PostMapping(path="/collections/digital-products/{digitalProductGUID}/update-status") public VoidResponse updateDigitalProductStatus(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String digitalProductGUID, @RequestBody(required=false) DigitalProductStatusRequestBody requestBody)
      Update the status of a digital product.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      digitalProductGUID - unique identifier of the digital product (returned from createCollection)
      requestBody - properties for the new element.
      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.

    • updateAgreementStatus

      @PostMapping(path="/collections/agreements/{agreementGUID}/update-status") public VoidResponse updateAgreementStatus(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementGUID, @RequestBody(required=false) AgreementStatusRequestBody requestBody)
      Update the status of an agreement.
      Parameters:
      serverName - name of called server.
      urlMarker - view service URL marker
      agreementGUID - unique identifier of the agreement (returned from createCollection)
      requestBody - properties for the new status.
      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, @RequestParam(required=false,defaultValue="false") boolean makeAnchor, @RequestBody(required=false) RelationshipRequestBody 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.
      makeAnchor - like the lifecycle of the collection to that of the parent so that if the parent is deleted, so is the collection
      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) MetadataSourceRequestBody 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 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) RelationshipRequestBody requestBody)
      Link two dependent digital products.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      consumerDigitalProductGUID - 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) MetadataSourceRequestBody requestBody)
      Unlink dependent digital products.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      consumerDigitalProductGUID - 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) RelationshipRequestBody 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 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) MetadataSourceRequestBody 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 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/{digitalProductManagerGUID}/attach") public VoidResponse linkProductManager(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String digitalProductGUID, @PathVariable String digitalProductManagerGUID, @RequestBody(required=false) RelationshipRequestBody requestBody)
      Attach a product manager to a digital product.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      digitalProductGUID - unique identifier of the digital product
      digitalProductManagerGUID - unique identifier of the product manager role
      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.

    • detachProductManager

      @PostMapping(path="/collection/digital-products/{digitalProductGUID}/product-managers/{digitalProductManagerGUID}/detach") public VoidResponse detachProductManager(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String digitalProductGUID, @PathVariable String digitalProductManagerGUID, @RequestBody(required=false) MetadataSourceRequestBody requestBody)
      Detach a product manager from a digital product.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      digitalProductGUID - unique identifier of the digital product
      digitalProductManagerGUID - unique identifier of the product manager role
      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.

    • 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) RelationshipRequestBody 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 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) MetadataSourceRequestBody 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 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) RelationshipRequestBody 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 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) MetadataSourceRequestBody 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 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) RelationshipRequestBody 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 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="/collection/agreements/{agreementGUID}/contract-links/{externalReferenceGUID}/detach") public VoidResponse detachContract(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String agreementGUID, @PathVariable String externalReferenceGUID, @RequestBody(required=false) MetadataSourceRequestBody 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 there is a problem retrieving information from the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.

    • deleteCollection

      @PostMapping(path="/collections/{collectionGUID}/delete") public VoidResponse deleteCollection(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestParam(required=false,defaultValue="false") boolean cascadedDelete, @RequestBody(required=false) MetadataSourceRequestBody 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.
      cascadedDelete - should any nested collections be deleted? If false, the delete fails if there are nested collections. If true, nested collections are delete - but not member elements unless they are anchored to the collection
      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

      @GetMapping(path="/collections/{collectionGUID}/members") public CollectionMembersResponse getCollectionMembers(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize)
      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.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      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.

    • getCollectionMembers

      @PostMapping(path="/collections/{collectionGUID}/members") public CollectionMembersResponse getCollectionMembers(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @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.
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return.
      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.

    • getCollectionGraph

      @PostMapping(path="/collections/{collectionGUID}/graph") public CollectionGraphResponse getCollectionGraph(@PathVariable String serverName, @PathVariable String urlMarker, @PathVariable String collectionGUID, @RequestParam(required=false,defaultValue="0") int startFrom, @RequestParam(required=false,defaultValue="0") int pageSize, @RequestBody(required=false) ResultsRequestBody requestBody)
      Return a graph of elements that are the nested members of a collection along with elements immediately connected to the starting collection. The result includes a mermaid graph of the returned elements.
      Parameters:
      serverName - name of called server
      urlMarker - view service URL marker
      collectionGUID - unique identifier of the collection
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      requestBody - 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) RelationshipRequestBody 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 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, @RequestParam boolean replaceAllProperties, @RequestBody(required=false) RelationshipRequestBody 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.
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      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 MetadataSourceRequestBody 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 there is a problem updating information in the property server(s). UserNotAuthorizedException the requesting user is not authorized to issue this request.