Package org.odpi.openmetadata.accessservices.governanceprogram.client.rest

Class GovernanceProgramRESTClient

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

org.odpi.openmetadata.accessservices.governanceprogram.client.rest.GovernanceProgramRESTClient

public class GovernanceProgramRESTClient
extends FFDCRESTClient

RESTClient is responsible for issuing calls to the Governance Program OMAS REST APIs.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
GovernanceProgramRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
GovernanceProgramRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
GovernanceProgramRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
GovernanceProgramRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
CertificationTypeResponse	callCertificationTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a CertificationTypeResponse object.
CertificationTypeListResponse	callCertificationTypeListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of CertificationTypeElement objects.
CertificationTypeListResponse	callCertificationTypeListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of CertificationTypeElement objects.
ElementStubListResponse	callElementStubListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ElementStubListResponse object.
ExternalReferenceResponse	callExternalReferenceGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ExternalReferenceResponse object.
ExternalReferenceListResponse	callExternalReferenceListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of ExternalReferenceElement objects.
ExternalReferenceListResponse	callExternalReferenceListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of ExternalReferenceElement objects.
GovernanceDefinitionResponse	callGovernanceDefinitionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDefinitionResponse object.
GovernanceDefinitionGraphResponse	callGovernanceDefinitionGraphGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDefinitionGraphResponse object.
GovernanceDefinitionListResponse	callGovernanceDefinitionListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDefinitionListResponse object.
GovernanceDefinitionListResponse	callGovernanceDefinitionListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceDefinitionListResponse objects.
GovernanceDomainResponse	callGovernanceDomainGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDomainResponse object.
GovernanceDomainListResponse	callGovernanceDomainListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceDomainListResponse objects.
GovernanceDomainListResponse	callGovernanceDomainListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceDomainListResponse objects.
GovernanceDomainSetResponse	callGovernanceDomainSetGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDomainSetResponse object.
GovernanceDomainSetListResponse	callGovernanceDomainSetListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceDomainSetListResponse object.
GovernanceDomainSetListResponse	callGovernanceDomainSetListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceDomainSetListResponse objects.
GovernanceMetricResponse	callGovernanceMetricGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceMetricResponse object.
GovernanceMetricListResponse	callGovernanceMetricListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list ofGovernanceMetricElement objects.
GovernanceMetricImplementationListResponse	callGovernanceMetricsImplementationListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceMetricImplementationListResponse object.
GovernanceRoleAppointeeListResponse	callGovernanceRoleAppointeeListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceRoleAppointee objects.
GovernanceRoleResponse	callGovernanceRoleGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceRoleResponse object.
GovernanceRoleHistoryResponse	callGovernanceRoleHistoryGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceRoleHistoryResponse object.
GovernanceRoleListResponse	callGovernanceRoleListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceRoleElement objects.
GovernanceRoleListResponse	callGovernanceRoleListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceRoleElement objects.
GovernanceZoneDefinitionResponse	callGovernanceZoneDefinitionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceZoneDefinitionResponse object.
GovernanceZoneResponse	callGovernanceZoneGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceZoneResponse object.
GovernanceZoneListResponse	callGovernanceZoneListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceZoneListResponse object.
GovernanceLevelIdentifierResponse	callLevelIdentifierGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceLevelIdentifierResponse object.
GovernanceLevelIdentifierResponse	callLevelIdentifierListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceLevelIdentifierResponse objects.
GovernanceLevelIdentifierListResponse	callLevelIdentifierListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceLevelIdentifierListResponse objects.
GovernanceLevelIdentifierSetResponse	callLevelIdentifierSetGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceLevelIdentifierSetResponse object.
GovernanceLevelIdentifierSetListResponse	callLevelIdentifierSetListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of GovernanceLevelIdentifierSetListResponse objects.
GovernanceLevelIdentifierSetResponse	callLevelIdentifierSetListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of GovernanceLevelIdentifierSetResponse objects.
LicenseListResponse	callLicenseListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of LicenseElement objects.
LicenseTypeResponse	callLicenseTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a LicenseTypeResponse object.
LicenseTypeListResponse	callLicenseTypeListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of LicenseTypeElement objects.
LicenseTypeListResponse	callLicenseTypeListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of LicenseTypeElement objects.
RelatedElementListResponse	callRelatedElementListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RelatedElementListResponse object.
GovernanceStatusIdentifierResponse	callStatusIdentifierGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceStatusIdentifierResponse object.
GovernanceStatusIdentifierSetResponse	callStatusIdentifierSetGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceStatusIdentifierSetResponse object.
GovernanceStatusIdentifierSetListResponse	callStatusIdentifierSetListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a GovernanceStatusIdentifierSetListResponse object.
SubjectAreaDefinitionResponse	callSubjectAreaDefinitionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SubjectAreaDefinitionResponse object.
SubjectAreaResponse	callSubjectAreaGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SubjectAreaResponse object.
SubjectAreaListResponse	callSubjectAreaListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SubjectAreaListResponse object.

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient

callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callStringMapGetRESTCall, callVoidGetRESTCall, callVoidPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase

callDeleteRESTCall, callDeleteRESTCall, callGetRESTCall, callGetRESTCall, callGetRESTCallNoParams, callPostRESTCall, callPostRESTCall, callPostRESTCallNoParams, callPutRESTCall, callPutRESTCall

Methods inherited from class java.lang.Object

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

Constructor Details

GovernanceProgramRESTClient

public GovernanceProgramRESTClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog)
                            throws InvalidParameterException

Constructor for no authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

auditLog - destination for log messages.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramRESTClient

public GovernanceProgramRESTClient(String serverName,
 String serverPlatformURLRoot)
                            throws InvalidParameterException

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramRESTClient

public GovernanceProgramRESTClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog)
                            throws InvalidParameterException

Constructor for simple userId and password authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

userId - user id for the HTTP request

password - password for the HTTP request

auditLog - destination for log messages.

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

GovernanceProgramRESTClient

public GovernanceProgramRESTClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password)
                            throws InvalidParameterException

Constructor for simple userId and password authentication.

Parameters:

serverName - name of the OMAG Server to call

serverPlatformURLRoot - URL root of the server platform where the OMAG Server is running.

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

Method Details

callCertificationTypeGetRESTCall

public CertificationTypeResponse callCertificationTypeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a CertificationTypeResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

CertificationTypeResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callCertificationTypeListGetRESTCall

public CertificationTypeListResponse callCertificationTypeListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of CertificationTypeElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

CertificationTypeListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callCertificationTypeListPostRESTCall

public CertificationTypeListResponse callCertificationTypeListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of CertificationTypeElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

CertificationTypeListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callElementStubListGetRESTCall

public ElementStubListResponse callElementStubListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a ElementStubListResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

ElementStubListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callExternalReferenceGetRESTCall

public ExternalReferenceResponse callExternalReferenceGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a ExternalReferenceResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

ExternalReferenceResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callExternalReferenceListGetRESTCall

public ExternalReferenceListResponse callExternalReferenceListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of ExternalReferenceElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

ExternalReferenceListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callExternalReferenceListPostRESTCall

public ExternalReferenceListResponse callExternalReferenceListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                    throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of ExternalReferenceElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

ExternalReferenceListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDefinitionListPostRESTCall

public GovernanceDefinitionListResponse callGovernanceDefinitionListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceDefinitionListResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDefinitionListGetRESTCall

public GovernanceDefinitionListResponse callGovernanceDefinitionListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDefinitionListResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDefinitionGetRESTCall

public GovernanceDefinitionResponse callGovernanceDefinitionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDefinitionResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDefinitionGraphGetRESTCall

public GovernanceDefinitionGraphResponse callGovernanceDefinitionGraphGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                           throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDefinitionGraphResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionGraphResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceMetricsImplementationListGetRESTCall

public GovernanceMetricImplementationListResponse callGovernanceMetricsImplementationListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceMetricImplementationListResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDefinitionGraphResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainSetListPostRESTCall

public GovernanceDomainSetListResponse callGovernanceDomainSetListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceDomainSetListResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainSetListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainSetListGetRESTCall

public GovernanceDomainSetListResponse callGovernanceDomainSetListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDomainSetListResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainSetGetRESTCall

public GovernanceDomainSetResponse callGovernanceDomainSetGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDomainSetResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainListPostRESTCall

public GovernanceDomainListResponse callGovernanceDomainListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceDomainListResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainListGetRESTCall

public GovernanceDomainListResponse callGovernanceDomainListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceDomainListResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceDomainGetRESTCall

public GovernanceDomainResponse callGovernanceDomainGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceDomainResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceDomainResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceMetricGetRESTCall

public GovernanceMetricResponse callGovernanceMetricGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceMetricResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceMetricResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceMetricListPostRESTCall

public GovernanceMetricListResponse callGovernanceMetricListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                  throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list ofGovernanceMetricElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceMetricListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLicenseTypeGetRESTCall

public LicenseTypeResponse callLicenseTypeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a LicenseTypeResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

LicenseTypeResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLicenseTypeListGetRESTCall

public LicenseTypeListResponse callLicenseTypeListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of LicenseTypeElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

LicenseTypeListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLicenseListGetRESTCall

public LicenseListResponse callLicenseListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of LicenseElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

LicenseListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLicenseTypeListPostRESTCall

public LicenseTypeListResponse callLicenseTypeListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                        throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of LicenseTypeElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

LicenseTypeListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callStatusIdentifierGetRESTCall

public GovernanceStatusIdentifierResponse callStatusIdentifierGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceStatusIdentifierResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceStatusIdentifierResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierGetRESTCall

public GovernanceLevelIdentifierResponse callLevelIdentifierGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceLevelIdentifierResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callStatusIdentifierSetGetRESTCall

public GovernanceStatusIdentifierSetResponse callStatusIdentifierSetGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                         throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceStatusIdentifierSetResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceStatusIdentifierSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callStatusIdentifierSetListGetRESTCall

public GovernanceStatusIdentifierSetListResponse callStatusIdentifierSetListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                                 throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceStatusIdentifierSetListResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceStatusIdentifierSetListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierListGetRESTCall

public GovernanceLevelIdentifierResponse callLevelIdentifierListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceLevelIdentifierResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierListPostRESTCall

public GovernanceLevelIdentifierListResponse callLevelIdentifierListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                          throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceLevelIdentifierListResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierSetGetRESTCall

public GovernanceLevelIdentifierSetResponse callLevelIdentifierSetGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                       throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceLevelIdentifierSetResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierSetListGetRESTCall

public GovernanceLevelIdentifierSetListResponse callLevelIdentifierSetListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceLevelIdentifierSetListResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierSetListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callLevelIdentifierSetListPostRESTCall

public GovernanceLevelIdentifierSetResponse callLevelIdentifierSetListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                            throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceLevelIdentifierSetResponse objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceLevelIdentifierSetResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleGetRESTCall

public GovernanceRoleResponse callGovernanceRoleGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceRoleResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRoleResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleHistoryGetRESTCall

public GovernanceRoleHistoryResponse callGovernanceRoleHistoryGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a GovernanceRoleHistoryResponse object.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRoleHistoryResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleListGetRESTCall

public GovernanceRoleListResponse callGovernanceRoleListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                             throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceRoleElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRoleListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleListPostRESTCall

public GovernanceRoleListResponse callGovernanceRoleListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                              throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a POST REST call that returns a list of GovernanceRoleElement objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

requestBody - request body for the REST call - contains most of the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRoleListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceRoleAppointeeListGetRESTCall

public GovernanceRoleAppointeeListResponse callGovernanceRoleAppointeeListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                               throws InvalidParameterException,
PropertyServerException,
UserNotAuthorizedException

Issue a GET REST call that returns a list of GovernanceRoleAppointee objects.

Parameters:

methodName - name of the method being called

urlTemplate - template of the URL with place-holders for the parameters

params - a list of parameters that are slotted into the url template

Returns:

GovernanceRoleAppointeeListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceZoneGetRESTCall

public GovernanceZoneResponse callGovernanceZoneGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceZoneResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

GovernanceZoneResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceZoneListGetRESTCall

public GovernanceZoneListResponse callGovernanceZoneListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceZoneListResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

GovernanceZoneListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callGovernanceZoneDefinitionGetRESTCall

public GovernanceZoneDefinitionResponse callGovernanceZoneDefinitionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a GovernanceZoneDefinitionResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

GovernanceZoneDefinitionResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callSubjectAreaGetRESTCall

public SubjectAreaResponse callSubjectAreaGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SubjectAreaResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

SubjectAreaResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callSubjectAreaDefinitionGetRESTCall

public SubjectAreaDefinitionResponse callSubjectAreaDefinitionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SubjectAreaDefinitionResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

SubjectAreaDefinitionResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callSubjectAreaListGetRESTCall

public SubjectAreaListResponse callSubjectAreaListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SubjectAreaListResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

SubjectAreaListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.

callRelatedElementListGetRESTCall

public RelatedElementListResponse callRelatedElementListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a RelatedElementListResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - REST API call URL template with place-holders for the parameters.

params - a list of parameters that are slotted into the url template.

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

UserNotAuthorizedException - the user is not authorized to make this request.

PropertyServerException - the repository is not available or not working properly.