Package org.odpi.openmetadata.accessservices.governanceprogram.server.spring

Class GovernanceCertificationsResource

java.lang.Object
org.odpi.openmetadata.accessservices.governanceprogram.server.spring.GovernanceCertificationsResource
@RestController @RequestMapping("/servers/{serverName}/open-metadata/access-services/governance-program/users/{userId}") public class GovernanceCertificationsResource extends Object
GovernanceCertificationsResource sets up the certification types that are part of an organization governance.

  • Constructor Details

    • GovernanceCertificationsResource

      public GovernanceCertificationsResource()
      Default constructor

  • Method Details

    • createCertificationType

      @PostMapping(path="/certification-types") public GUIDResponse createCertificationType(@PathVariable String serverName, @PathVariable String userId, @RequestBody GovernanceDefinitionRequestBody requestBody)
      Create a description of the certification type.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      requestBody - certification properties and initial status
      Returns:
      unique identifier of new definition or InvalidParameterException documentIdentifier or userId is null; documentIdentifier is not unique PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • updateCertificationType

      @PostMapping(path="/certification-types/{certificationTypeGUID}/update") public VoidResponse updateCertificationType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String certificationTypeGUID, @RequestParam boolean isMergeUpdate, @RequestBody GovernanceDefinitionRequestBody requestBody)
      Update the properties of the certification type.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      certificationTypeGUID - identifier of the governance definition to change
      isMergeUpdate - are unspecified properties unchanged (true) or replaced with null?
      requestBody - certification properties
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • deleteCertificationType

      @PostMapping(path="/certification-types/{certificationTypeGUID}/delete") public VoidResponse deleteCertificationType(@PathVariable String serverName, @PathVariable String userId, @PathVariable String certificationTypeGUID, @RequestBody ExternalSourceRequestBody requestBody)
      Delete the properties of the certification type.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      certificationTypeGUID - identifier of the governance definition to delete
      requestBody - external source request body
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertificationTypeByGUID

      @GetMapping(path="/certification-types/{certificationTypeGUID}") public CertificationTypeResponse getCertificationTypeByGUID(@PathVariable String serverName, @PathVariable String userId, @PathVariable String certificationTypeGUID)
      Retrieve the certification type by the unique identifier assigned by this service when it was created.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      certificationTypeGUID - identifier of the governance definition to retrieve
      Returns:
      properties of the certification type or InvalidParameterException guid or userId is null; guid is not recognized PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertificationTypeByDocId

      @GetMapping(path="/certification-types/by-document-id/{documentIdentifier}") public CertificationTypeResponse getCertificationTypeByDocId(@PathVariable String serverName, @PathVariable String userId, @PathVariable String documentIdentifier)
      Retrieve the certification type by its assigned unique document identifier.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      documentIdentifier - identifier to search for
      Returns:
      properties of the matching certification type or InvalidParameterException documentIdentifier or userId is null; documentIdentifier is not recognized PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertificationTypesByTitle

      @PostMapping(path="/certification-types/by-title") public CertificationTypesResponse getCertificationTypesByTitle(@PathVariable String serverName, @PathVariable String userId, @RequestParam int startFrom, @RequestParam int pageSize, @RequestBody SearchStringRequestBody requestBody)
      Retrieve all the certification types for a particular title. The title can include regEx wildcards.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      requestBody - short description of the certification
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      list of matching certification types (null if no matching elements) or InvalidParameterException title or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertificationTypeByDomainId

      @GetMapping(path="/certification-types/by-domain/{domainIdentifier}") public CertificationTypesResponse getCertificationTypeByDomainId(@PathVariable String serverName, @PathVariable String userId, @PathVariable int domainIdentifier, @RequestParam int startFrom, @RequestParam int pageSize)
      Retrieve all the certification type definitions for a specific governance domain.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      domainIdentifier - identifier to search for
      startFrom - where to start from in the list of definitions
      pageSize - max number of results to return in one call
      Returns:
      properties of the matching certification type definitions or InvalidParameterException domainIdentifier or userId is null; domainIdentifier is not recognized PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • certifyElement

      @PostMapping(path="/elements/{elementGUID}/certification-types/{certificationTypeGUID}/certify") public GUIDResponse certifyElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @PathVariable String certificationTypeGUID, @RequestBody RelationshipRequestBody requestBody)
      Link an element to a certification type and include details of the certification in the relationship properties.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier of the element being certified
      certificationTypeGUID - unique identifier for the certification type
      requestBody - the properties of the certification
      Returns:
      guid or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • updateCertification

      @PostMapping(path="/certifications/{certificationGUID}/update") public VoidResponse updateCertification(@PathVariable String serverName, @PathVariable String userId, @PathVariable String certificationGUID, @RequestParam boolean isMergeUpdate, @RequestBody RelationshipRequestBody requestBody)
      Update the properties of a certification. Remember to include the certificationId in the properties if the element has multiple certifications for the same certification type.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      certificationGUID - unique identifier for the certification relationship
      isMergeUpdate - should the supplied properties overlay the existing properties or replace them
      requestBody - the properties of the certification
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • decertifyElement

      @PostMapping(path="/certifications/{certificationGUID}/delete") public VoidResponse decertifyElement(@PathVariable String serverName, @PathVariable String userId, @PathVariable String certificationGUID, @RequestBody RelationshipRequestBody requestBody)
      Remove the certification for an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      certificationGUID - unique identifier for the certification relationship
      requestBody - external source information.
      Returns:
      void or InvalidParameterException one of the properties is invalid PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertifiedElements

      @GetMapping(path="/elements/certifications/{certificationGUID}") public RelatedElementsResponse getCertifiedElements(@PathVariable String serverName, @PathVariable String userId, @PathVariable String certificationGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Return information about the elements linked to a certification.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      certificationGUID - unique identifier for the certification
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      properties of the certification or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem

    • getCertifications

      @GetMapping(path="/elements/{elementGUID}/certifications") public RelatedElementsResponse getCertifications(@PathVariable String serverName, @PathVariable String userId, @PathVariable String elementGUID, @RequestParam int startFrom, @RequestParam int pageSize)
      Return information about the certifications linked to an element.
      Parameters:
      serverName - name of the server instance to connect to
      userId - calling user
      elementGUID - unique identifier for the certification
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      properties of the certification or InvalidParameterException qualifiedName or userId is null PropertyServerException problem accessing property server UserNotAuthorizedException security access problem