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

Class DataManagerRESTClient

java.lang.Object

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

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

org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient

org.odpi.openmetadata.accessservices.datamanager.client.rest.DataManagerRESTClient

public class DataManagerRESTClient
extends OCFRESTClient

DataManagerRESTClient is responsible for issuing calls to the 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
DataManagerRESTClient(String serverName, String serverPlatformURLRoot)	Constructor for no authentication.
DataManagerRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password)	Constructor for simple userId and password authentication.
DataManagerRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog)	Constructor for simple userId and password authentication with audit log.
DataManagerRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)	Constructor for no authentication with audit log.

Method Summary

Modifier and Type	Method	Description
APIResponse	callAPIGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a APIResponse object.
APIOperationResponse	callAPIOperationGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a APIOperationResponse object.
APIOperationsResponse	callAPIOperationsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a APIOperationsResponse object.
APIOperationsResponse	callAPIOperationsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a APIOperationsResponse object.
APIParameterListResponse	callAPIParameterListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a APIParameterListResponse object.
APIParameterListsResponse	callAPIParameterListsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a APIParameterListsResponse object.
APIParameterListsResponse	callAPIParameterListsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a APIParameterListsResponse object.
APIsResponse	callAPIsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a APIsResponse object.
APIsResponse	callAPIsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a APIsResponse object.
DatabaseColumnResponse	callDatabaseColumnGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseColumnResponse object.
DatabaseColumnsResponse	callDatabaseColumnsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseColumnsResponse object.
DatabaseColumnsResponse	callDatabaseColumnsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DatabaseColumnsResponse object.
DatabaseResponse	callDatabaseGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseResponse object.
DatabaseSchemaResponse	callDatabaseSchemaGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseSchemaResponse object.
DatabaseSchemasResponse	callDatabaseSchemasGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseSchemasResponse object.
DatabaseSchemasResponse	callDatabaseSchemasPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DatabaseSchemasResponse object.
DatabasesResponse	callDatabasesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabasesResponse object.
DatabasesResponse	callDatabasesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a DatabasesResponse object.
DatabaseTableResponse	callDatabaseTableGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseTableResponse object.
DatabaseTablesResponse	callDatabaseTablesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseTablesResponse object.
DatabaseTablesResponse	callDatabaseTablesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DatabaseTablesResponse object.
DatabaseViewResponse	callDatabaseViewGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseViewResponse object.
DatabaseViewsResponse	callDatabaseViewsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DatabaseViewsResponse object.
DatabaseViewsResponse	callDatabaseViewsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DatabaseViewsResponse object.
DataContainerResponse	callDataContainerGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DataContainerResponse object.
DataContainersResponse	callDataContainersGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DataContainersResponse object.
DataContainersResponse	callDataContainersPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DataContainersResponse object.
DataFileResponse	callDataFileGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DataFileResponse object.
DataFileResponse	callDataFilePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DataFileResponse object.
DataFilesResponse	callDataFilesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a DataFilesResponse object.
DataFilesResponse	callDataFilesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DataFilesResponse object.
ElementStubResponse	callElementStubGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ElementStubResponse object.
EventTypeResponse	callEventTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EventTypeResponse object.
EventTypesResponse	callEventTypesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EventTypesResponse object.
EventTypesResponse	callEventTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a EventTypesResponse object.
ExternalReferenceResponse	callExternalReferenceGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ExternalReferenceResponse object.
ExternalReferencesResponse	callExternalReferencesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ExternalReferencesResponse object.
ExternalReferencesResponse	callExternalReferencesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ExternalReferencesResponse object.
FileFolderResponse	callFileFolderGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a FileFolderResponse object.
FileFolderResponse	callFileFolderPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a FileFolderResponse object.
FileFoldersResponse	callFileFoldersGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a FileFoldersResponse object.
FormResponse	callFormGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a FormResponse object.
FormsResponse	callFormsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a FormsResponse object.
FormsResponse	callFormsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a FormsResponse object.
ConnectionResponse	callMyConnectionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectionResponse object.
ConnectionsResponse	callMyConnectionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectionsResponse object.
ConnectionsResponse	callMyConnectionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectionsResponse object.
ConnectorTypeResponse	callMyConnectorTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectorReportResponse object.
ConnectorTypesResponse	callMyConnectorTypesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectorTypesResponse object.
ConnectorTypesResponse	callMyConnectorTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectorTypesResponse object.
EndpointResponse	callMyEndpointGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EndpointResponse object.
EndpointsResponse	callMyEndpointsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EndpointsResponse object.
EndpointsResponse	callMyEndpointsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a EndpointsResponse object.
QueriesResponse	callQueriesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a QueriesResponse object.
QueriesResponse	callQueriesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a QueriesResponse object.
QueryResponse	callQueryGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a QueryResponse object.
RelatedElementListResponse	callRelatedElementListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RelatedElementListResponse object.
ReportResponse	callReportGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ReportResponse object.
ReportsResponse	callReportsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ReportsResponse object.
ReportsResponse	callReportsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ReportsResponse object.
SchemaAttributeResponse	callSchemaAttributeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SchemaAttributeResponse object.
SchemaAttributeResponse	callSchemaAttributePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SchemaAttributeResponse object.
SchemaAttributesResponse	callSchemaAttributesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SchemaAttributesResponse object.
SchemaAttributesResponse	callSchemaAttributesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SchemaAttributesResponse object.
SchemaTypeResponse	callSchemaTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SchemaTypeResponse object.
SchemaTypeResponse	callSchemaTypePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SchemaTypeResponse object.
SchemaTypesResponse	callSchemaTypesGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SchemaTypesResponse object.
SchemaTypesResponse	callSchemaTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SchemaTypesResponse object.
TopicResponse	callTopicGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a TopicResponse object.
TopicsResponse	callTopicsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a TopicsResponse object.
TopicsResponse	callTopicsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a TopicsResponse object.
ValidValueResponse	callValidValueGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ValidValueElement in a response object.
ValidValueListResponse	callValidValueListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of ValidValueElements in a response object.
ValidValueListResponse	callValidValueListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a list of ValidValueElements in a response object.
ValidValueSetsResponse	callValidValueSetsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ValidValueSetsResponse object.

Methods inherited from class org.odpi.openmetadata.frameworkservices.ocf.metadatamanagement.client.OCFRESTClient

callOCFAssetGetRESTCall, callOCFAssetsGetRESTCall, callOCFAssetsPostRESTCall, callOCFConnectionGetRESTCall, callOCFTagGetRESTCall, callOCFTagListGetRESTCall, callOCFTagListPostRESTCall

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

callBooleanGetRESTCall, 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

DataManagerRESTClient

public DataManagerRESTClient(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 manager 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.

DataManagerRESTClient

public DataManagerRESTClient(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 manager where the OMAG Server is running.

Throws:

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

DataManagerRESTClient

public DataManagerRESTClient(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 manager 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.

DataManagerRESTClient

public DataManagerRESTClient(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 manager 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

callMyConnectionGetRESTCall

public ConnectionResponse callMyConnectionGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ConnectionResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

ConnectionResponse

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.

callMyConnectionsGetRESTCall

public ConnectionsResponse callMyConnectionsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ConnectionsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

ConnectionsResponse

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.

callMyConnectionsPostRESTCall

public ConnectionsResponse callMyConnectionsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a ConnectionsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

ConnectionsResponse

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.

callMyConnectorTypeGetRESTCall

public ConnectorTypeResponse callMyConnectorTypeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ConnectorReportResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

ConnectorReportResponse

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.

callMyConnectorTypesGetRESTCall

public ConnectorTypesResponse callMyConnectorTypesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ConnectorTypesResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

ConnectorTypesResponse

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.

callMyConnectorTypesPostRESTCall

public ConnectorTypesResponse callMyConnectorTypesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a ConnectorTypesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

ConnectorTypesResponse

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.

callMyEndpointGetRESTCall

public EndpointResponse callMyEndpointGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a EndpointResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

EndpointResponse

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.

callMyEndpointsGetRESTCall

public EndpointsResponse callMyEndpointsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a EndpointsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

EndpointsResponse

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.

callMyEndpointsPostRESTCall

public EndpointsResponse callMyEndpointsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a EndpointsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

EndpointsResponse

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,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ExternalReferenceResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callExternalReferencesGetRESTCall

public ExternalReferencesResponse callExternalReferencesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ExternalReferencesResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

ExternalReferencesResponse

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.

callExternalReferencesPostRESTCall

public ExternalReferencesResponse callExternalReferencesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a ExternalReferencesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

ExternalReferencesResponse

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.

callDatabaseColumnGetRESTCall

public DatabaseColumnResponse callDatabaseColumnGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseColumnResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabaseColumnsGetRESTCall

public DatabaseColumnsResponse callDatabaseColumnsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseColumnsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabaseColumnsPostRESTCall

public DatabaseColumnsResponse callDatabaseColumnsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a DatabaseColumnsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callDatabaseGetRESTCall

public DatabaseResponse callDatabaseGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabasesGetRESTCall

public DatabasesResponse callDatabasesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabasesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabasesPostRESTCall

public DatabasesResponse callDatabasesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabasesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callDatabaseSchemaGetRESTCall

public DatabaseSchemaResponse callDatabaseSchemaGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseSchemaResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabaseSchemasGetRESTCall

public DatabaseSchemasResponse callDatabaseSchemasGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseSchemasResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabaseSchemasPostRESTCall

public DatabaseSchemasResponse callDatabaseSchemasPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a DatabaseSchemasResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callDatabaseTableGetRESTCall

public DatabaseTableResponse callDatabaseTableGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseTableResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabaseTablesGetRESTCall

public DatabaseTablesResponse callDatabaseTablesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseTablesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabaseTablesPostRESTCall

public DatabaseTablesResponse callDatabaseTablesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a DatabaseTablesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callDatabaseViewGetRESTCall

public DatabaseViewResponse callDatabaseViewGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseViewResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabaseViewsGetRESTCall

public DatabaseViewsResponse callDatabaseViewsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DatabaseViewsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDatabaseViewsPostRESTCall

public DatabaseViewsResponse callDatabaseViewsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a DatabaseViewsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callDataContainerGetRESTCall

public DataContainerResponse callDataContainerGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DataContainerResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDataContainersGetRESTCall

public DataContainersResponse callDataContainersGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DataContainersResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDataContainersPostRESTCall

public DataContainersResponse callDataContainersPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a DataContainersResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callDataFileGetRESTCall

public DataFileResponse callDataFileGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DataFileResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDataFilePostRESTCall

public DataFileResponse callDataFilePostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a DataFileResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callDataFilesGetRESTCall

public DataFilesResponse callDataFilesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a DataFilesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callDataFilesPostRESTCall

public DataFilesResponse callDataFilesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a DataFilesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callFileFolderGetRESTCall

public FileFolderResponse callFileFolderGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a FileFolderResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callFileFolderPostRESTCall

public FileFolderResponse callFileFolderPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a FileFolderResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callFileFoldersGetRESTCall

public FileFoldersResponse callFileFoldersGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a FileFoldersResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callFormGetRESTCall

public FormResponse callFormGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a FormResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callFormsGetRESTCall

public FormsResponse callFormsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a FormsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callFormsPostRESTCall

public FormsResponse callFormsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a FormsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callQueryGetRESTCall

public QueryResponse callQueryGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a QueryResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callQueriesGetRESTCall

public QueriesResponse callQueriesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a QueriesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callQueriesPostRESTCall

public QueriesResponse callQueriesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a QueriesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callReportGetRESTCall

public ReportResponse callReportGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ReportResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callReportsGetRESTCall

public ReportsResponse callReportsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ReportsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callReportsPostRESTCall

public ReportsResponse callReportsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a ReportsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callTopicGetRESTCall

public TopicResponse callTopicGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a TopicResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callTopicsGetRESTCall

public TopicsResponse callTopicsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a TopicsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callTopicsPostRESTCall

public TopicsResponse callTopicsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a TopicsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callEventTypeGetRESTCall

public EventTypeResponse callEventTypeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a EventTypeResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callEventTypesGetRESTCall

public EventTypesResponse callEventTypesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a EventTypesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callEventTypesPostRESTCall

public EventTypesResponse callEventTypesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a EventTypesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callAPIGetRESTCall

public APIResponse callAPIGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a APIResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callAPIsGetRESTCall

public APIsResponse callAPIsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a APIsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callAPIsPostRESTCall

public APIsResponse callAPIsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a APIsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - request body for the request.

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.

callAPIOperationGetRESTCall

public APIOperationResponse callAPIOperationGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a APIOperationResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callAPIOperationsGetRESTCall

public APIOperationsResponse callAPIOperationsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a APIOperationsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callAPIOperationsPostRESTCall

public APIOperationsResponse callAPIOperationsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a APIOperationsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - request body for the request.

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.

callAPIParameterListGetRESTCall

public APIParameterListResponse callAPIParameterListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a APIParameterListResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callAPIParameterListsGetRESTCall

public APIParameterListsResponse callAPIParameterListsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a APIParameterListsResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callAPIParameterListsPostRESTCall

public APIParameterListsResponse callAPIParameterListsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a APIParameterListsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - request body for the request.

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.

callSchemaAttributePostRESTCall

public SchemaAttributeResponse callSchemaAttributePostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a SchemaAttributeResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callSchemaAttributesPostRESTCall

public SchemaAttributesResponse callSchemaAttributesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a SchemaAttributesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callSchemaAttributeGetRESTCall

public SchemaAttributeResponse callSchemaAttributeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SchemaAttributeResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callSchemaAttributesGetRESTCall

public SchemaAttributesResponse callSchemaAttributesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SchemaAttributesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callSchemaTypePostRESTCall

public SchemaTypeResponse callSchemaTypePostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a SchemaTypeResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callSchemaTypeGetRESTCall

public SchemaTypeResponse callSchemaTypeGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SchemaTypeResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callSchemaTypesGetRESTCall

public SchemaTypesResponse callSchemaTypesGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a SchemaTypesResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

callSchemaTypesPostRESTCall

public SchemaTypesResponse callSchemaTypesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a SchemaTypesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callValidValueSetsPostRESTCall

public ValidValueSetsResponse callValidValueSetsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a ValidValueSetsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional 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.

callElementStubGetRESTCall

public ElementStubResponse callElementStubGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ElementStubResponse object.

Parameters:

methodName - name of the method being called.

urlTemplate - template of the URL for the REST API 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.

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.

callValidValueGetRESTCall

public ValidValueResponse callValidValueGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a ValidValueElement in a response 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 - something went wrong with the REST call stack.

callValidValueListGetRESTCall

public ValidValueListResponse callValidValueListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a list of ValidValueElements in a response 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 - something went wrong with the REST call stack.

callValidValueListPostRESTCall

public ValidValueListResponse callValidValueListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a list of ValidValueElements in a response object.

Parameters:

methodName - name of the method being called

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

requestBody - request body for the request

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 - something went wrong with the REST call stack.