DataManagerRESTClient (Data Manager OMAS Client 2.11 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
- - org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
  - - org.odpi.openmetadata.commonservices.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 and Description
`DataManagerRESTClient(String serverName, String serverPlatformURLRoot)` Constructor for no authentication.
`DataManagerRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog)` Constructor for no authentication with audit log.
`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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`APIParameterResponse`	`callAPIParameterGetRESTCall(String methodName, String urlTemplate, Object... params)` Issue a GET REST call that returns a APIParameterResponse 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.
`APIParametersResponse`	`callAPIParametersGetRESTCall(String methodName, String urlTemplate, Object... params)` Issue a GET REST call that returns a APIParametersResponse object.
`APIsResponse`	`callAPIsGetRESTCall(String methodName, String urlTemplate, Object... params)` Issue a GET REST call that returns a APIsResponse object.
`APISpecificationResponse`	`callAPISpecificationGetRESTCall(String methodName, String urlTemplate, Object... params)` Issue a GET REST call that returns a APISpecificationResponse object.
`APISpecificationsResponse`	`callAPISpecificationsGetRESTCall(String methodName, String urlTemplate, Object... params)` Issue a GET REST call that returns a APISpecificationsResponse 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.
`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.
`DatabasesResponse`	`callDatabasesGetRESTCall(String methodName, String urlTemplate, 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.
`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.
`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.
`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.
`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.
`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.
`ValidValueSetsResponse`	`callValidValueSetsGetRESTCall(String methodName, String urlTemplate, Object... params)` Issue a GET REST call that returns a ValidValueSetsResponse object.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.client.OCFRESTClient
callAssetGetRESTCall, callAssetsGetRESTCall, callAssetsPostRESTCall, callConnectionGetRESTCall, callTagGetRESTCall, callTagListGetRESTCall, callTagListPostRESTCall

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
callConnectorTypeGetRESTCall, callCountGetRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callNameListGetRESTCall, 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 Detail
- 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 Detail

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 call 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 call 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.

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 call 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 call 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.

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 call 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 call 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.

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 call 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 call 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.

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 call 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 call 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.

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 call 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 call 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 call 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 call 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 call 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 call 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 call 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.

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 call 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 call 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.

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 call 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 call 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.

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 call 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 call 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.

callAPISpecificationGetRESTCall

public APISpecificationResponse callAPISpecificationGetRESTCall(String methodName,
                                                                String urlTemplate,
                                                                Object... params)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Issue a GET REST call that returns a APISpecificationResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call 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.

callAPISpecificationsGetRESTCall

public APISpecificationsResponse callAPISpecificationsGetRESTCall(String methodName,
                                                                  String urlTemplate,
                                                                  Object... params)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException

Issue a GET REST call that returns a APISpecificationsResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call 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.

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 call 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 call 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.

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 call 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 call 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.

callAPIParameterGetRESTCall

public APIParameterResponse callAPIParameterGetRESTCall(String methodName,
                                                        String urlTemplate,
                                                        Object... params)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Issue a GET REST call that returns a APIParameterResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call 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.

callAPIParametersGetRESTCall

public APIParametersResponse callAPIParametersGetRESTCall(String methodName,
                                                          String urlTemplate,
                                                          Object... params)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Issue a GET REST call that returns a APIParametersResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call 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.

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 call 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 call 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 call 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 call 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 call 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 call 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 call 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.

callValidValueSetsGetRESTCall

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

Issue a GET REST call that returns a ValidValueSetsResponse object.

Parameters:: methodName - name of the method being called.; urlTemplate - template of the URL for the REST API call 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.

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 call 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.

Class DataManagerRESTClient

Field Summary

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

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

DataManagerRESTClient

DataManagerRESTClient

DataManagerRESTClient

DataManagerRESTClient

Method Detail

callDatabaseColumnGetRESTCall

callDatabaseColumnsGetRESTCall

callDatabaseGetRESTCall

callDatabasesGetRESTCall

callDatabaseSchemaGetRESTCall

callDatabaseSchemasGetRESTCall

callDatabaseTableGetRESTCall

callDatabaseTablesGetRESTCall

callDatabaseViewGetRESTCall

callDatabaseViewsGetRESTCall

callDataFileGetRESTCall

callDataFilePostRESTCall

callDataFilesGetRESTCall

callDataFilesPostRESTCall

callFileFolderGetRESTCall

callFileFolderPostRESTCall

callFileFoldersGetRESTCall

callTopicGetRESTCall

callTopicsGetRESTCall

callEventTypeGetRESTCall

callEventTypesGetRESTCall

callAPIGetRESTCall

callAPIsGetRESTCall

callAPISpecificationGetRESTCall

callAPISpecificationsGetRESTCall

callAPIOperationGetRESTCall

callAPIOperationsGetRESTCall

callAPIParameterListGetRESTCall

callAPIParameterListsGetRESTCall

callAPIParameterGetRESTCall

callAPIParametersGetRESTCall

callSchemaAttributePostRESTCall

callSchemaAttributesPostRESTCall

callSchemaAttributeGetRESTCall

callSchemaAttributesGetRESTCall

callSchemaTypePostRESTCall

callSchemaTypeGetRESTCall

callSchemaTypesGetRESTCall

callValidValueSetsGetRESTCall

callElementStubGetRESTCall