org.odpi.openmetadata.accessservices.assetmanager.client.rest

Class AssetManagerRESTClient

java.lang.Object

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

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

org.odpi.openmetadata.accessservices.assetmanager.client.rest.AssetManagerRESTClient

public class AssetManagerRESTClient
extends FFDCRESTClient

AssetManagerRESTClient 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
AssetManagerRESTClient(String serverName, String serverPlatformURLRoot) Constructor for no authentication.
AssetManagerRESTClient(String serverName, String serverPlatformURLRoot, AuditLog auditLog) Constructor for no authentication with audit log.
AssetManagerRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password) Constructor for simple userId and password authentication.
AssetManagerRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, AuditLog auditLog) Constructor for simple userId and password authentication with audit log.

Method Summary

Modifier and Type	Method and Description
ControlFlowElementResponse	callControlFlowPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ControlFlowElementResponse object.
ControlFlowElementsResponse	callControlFlowsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ControlFlowElementsResponse object.
AssetElementResponse	callDataAssetPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a AssetElementResponse object.
AssetElementsResponse	callDataAssetsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a AssetElementsResponse object.
DataFlowElementResponse	callDataFlowPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a DataFlowElementResponse object.
DataFlowElementsResponse	callDataFlowsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a DataFlowElementsResponse object.
ElementHeaderResponse	callElementHeaderPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ElementHeaderResponse object.
ElementHeadersResponse	callElementHeadersPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ElementHeadersResponse object.
ExternalGlossaryLinkElementsResponse	callExternalGlossaryLinksGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ExternalGlossaryLinkElementsResponse object.
GlossaryElementsResponse	callGlossariesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryElementsResponse object.
GlossaryCategoryElementsResponse	callGlossaryCategoriesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryCategoryElementsResponse object.
GlossaryCategoryElementResponse	callGlossaryCategoryPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryCategoryElementResponse object.
GlossaryElementResponse	callGlossaryPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryElementResponse object.
GlossaryTermElementResponse	callGlossaryTermPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryTermElementResponse object.
GlossaryTermElementsResponse	callGlossaryTermsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryTermElementsResponse object.
LineageMappingElementsResponse	callLineageMappingsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a LineageMappingElementsResponse object.
PortElementResponse	callPortPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a PortElementResponse object.
PortElementsResponse	callPortsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a PortElementsResponse object.
ProcessCallElementResponse	callProcessCallPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ProcessCallElementResponse object.
ProcessCallElementsResponse	callProcessCallsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ProcessCallElementsResponse object.
ProcessElementsResponse	callProcessesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ProcessElementsResponse object.
ProcessElementResponse	callProcessPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ProcessElementResponse object.
SchemaAttributeElementResponse	callSchemaAttributePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SchemaAttributeElementResponse object.
SchemaAttributeElementsResponse	callSchemaAttributesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SchemaAttributeElementsResponse object.
SchemaTypeElementResponse	callSchemaTypePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SchemaTypeElementResponse object.
SchemaTypeElementsResponse	callSchemaTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SchemaTypeElementsResponse object.

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

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

AssetManagerRESTClient

public AssetManagerRESTClient(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.

AssetManagerRESTClient

public AssetManagerRESTClient(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.

AssetManagerRESTClient

public AssetManagerRESTClient(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.

AssetManagerRESTClient

public AssetManagerRESTClient(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

callGlossaryPostRESTCall

public GlossaryElementResponse callGlossaryPostRESTCall(String methodName,
                                                        String urlTemplate,
                                                        Object requestBody,
                                                        Object... params)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Issue a POST REST call that returns a GlossaryElementResponse 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.

callGlossariesPostRESTCall

public GlossaryElementsResponse callGlossariesPostRESTCall(String methodName,
                                                           String urlTemplate,
                                                           Object requestBody,
                                                           Object... params)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Issue a POST REST call that returns a GlossaryElementsResponse 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.

callGlossaryCategoryPostRESTCall

public GlossaryCategoryElementResponse callGlossaryCategoryPostRESTCall(String methodName,
                                                                        String urlTemplate,
                                                                        Object requestBody,
                                                                        Object... params)
                                                                 throws InvalidParameterException,
                                                                        UserNotAuthorizedException,
                                                                        PropertyServerException

Issue a POST REST call that returns a GlossaryCategoryElementResponse 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.

callGlossaryCategoriesPostRESTCall

public GlossaryCategoryElementsResponse callGlossaryCategoriesPostRESTCall(String methodName,
                                                                           String urlTemplate,
                                                                           Object requestBody,
                                                                           Object... params)
                                                                    throws InvalidParameterException,
                                                                           UserNotAuthorizedException,
                                                                           PropertyServerException

Issue a POST REST call that returns a GlossaryCategoryElementsResponse 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.

callGlossaryTermPostRESTCall

public GlossaryTermElementResponse callGlossaryTermPostRESTCall(String methodName,
                                                                String urlTemplate,
                                                                Object requestBody,
                                                                Object... params)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Issue a POST REST call that returns a GlossaryTermElementResponse 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.

callGlossaryTermsPostRESTCall

public GlossaryTermElementsResponse callGlossaryTermsPostRESTCall(String methodName,
                                                                  String urlTemplate,
                                                                  Object requestBody,
                                                                  Object... params)
                                                           throws InvalidParameterException,
                                                                  UserNotAuthorizedException,
                                                                  PropertyServerException

Issue a POST REST call that returns a GlossaryTermElementsResponse 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.

callExternalGlossaryLinksGetRESTCall

public ExternalGlossaryLinkElementsResponse callExternalGlossaryLinksGetRESTCall(String methodName,
                                                                                 String urlTemplate,
                                                                                 Object... params)
                                                                          throws InvalidParameterException,
                                                                                 UserNotAuthorizedException,
                                                                                 PropertyServerException

Issue a GET REST call that returns a ExternalGlossaryLinkElementsResponse 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.

callElementHeaderPostRESTCall

public ElementHeaderResponse callElementHeaderPostRESTCall(String methodName,
                                                           String urlTemplate,
                                                           Object requestBody,
                                                           Object... params)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException

Issue a POST REST call that returns a ElementHeaderResponse 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.

callElementHeadersPostRESTCall

public ElementHeadersResponse callElementHeadersPostRESTCall(String methodName,
                                                             String urlTemplate,
                                                             Object requestBody,
                                                             Object... params)
                                                      throws InvalidParameterException,
                                                             UserNotAuthorizedException,
                                                             PropertyServerException

Issue a POST REST call that returns a ElementHeadersResponse 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.

callDataAssetPostRESTCall

public AssetElementResponse callDataAssetPostRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object requestBody,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Issue a POST REST call that returns a AssetElementResponse 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.

callDataAssetsPostRESTCall

public AssetElementsResponse callDataAssetsPostRESTCall(String methodName,
                                                        String urlTemplate,
                                                        Object requestBody,
                                                        Object... params)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Issue a POST REST call that returns a AssetElementsResponse 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.

callPortPostRESTCall

public PortElementResponse callPortPostRESTCall(String methodName,
                                                String urlTemplate,
                                                Object requestBody,
                                                Object... params)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Issue a POST REST call that returns a PortElementResponse 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.

callPortsPostRESTCall

public PortElementsResponse callPortsPostRESTCall(String methodName,
                                                  String urlTemplate,
                                                  Object requestBody,
                                                  Object... params)
                                           throws InvalidParameterException,
                                                  UserNotAuthorizedException,
                                                  PropertyServerException

Issue a POST REST call that returns a PortElementsResponse 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.

callProcessPostRESTCall

public ProcessElementResponse callProcessPostRESTCall(String methodName,
                                                      String urlTemplate,
                                                      Object requestBody,
                                                      Object... params)
                                               throws InvalidParameterException,
                                                      UserNotAuthorizedException,
                                                      PropertyServerException

Issue a POST REST call that returns a ProcessElementResponse 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.

callProcessesPostRESTCall

public ProcessElementsResponse callProcessesPostRESTCall(String methodName,
                                                         String urlTemplate,
                                                         Object requestBody,
                                                         Object... params)
                                                  throws InvalidParameterException,
                                                         UserNotAuthorizedException,
                                                         PropertyServerException

Issue a POST REST call that returns a ProcessElementsResponse 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.

callSchemaAttributePostRESTCall

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

Issue a POST REST call that returns a SchemaAttributeElementResponse 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 SchemaAttributeElementsResponse callSchemaAttributesPostRESTCall(String methodName,
                                                                        String urlTemplate,
                                                                        Object requestBody,
                                                                        Object... params)
                                                                 throws InvalidParameterException,
                                                                        UserNotAuthorizedException,
                                                                        PropertyServerException

Issue a POST REST call that returns a SchemaAttributeElementsResponse 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.

callSchemaTypePostRESTCall

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

Issue a POST REST call that returns a SchemaTypeElementResponse 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.

callSchemaTypesPostRESTCall

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

Issue a POST REST call that returns a SchemaTypeElementsResponse 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.

callDataFlowPostRESTCall

public DataFlowElementResponse callDataFlowPostRESTCall(String methodName,
                                                        String urlTemplate,
                                                        Object requestBody,
                                                        Object... params)
                                                 throws InvalidParameterException,
                                                        UserNotAuthorizedException,
                                                        PropertyServerException

Issue a POST REST call that returns a DataFlowElementResponse 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.

callDataFlowsPostRESTCall

public DataFlowElementsResponse callDataFlowsPostRESTCall(String methodName,
                                                          String urlTemplate,
                                                          Object requestBody,
                                                          Object... params)
                                                   throws InvalidParameterException,
                                                          UserNotAuthorizedException,
                                                          PropertyServerException

Issue a POST REST call that returns a DataFlowElementsResponse 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.

callControlFlowPostRESTCall

public ControlFlowElementResponse callControlFlowPostRESTCall(String methodName,
                                                              String urlTemplate,
                                                              Object requestBody,
                                                              Object... params)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Issue a POST REST call that returns a ControlFlowElementResponse 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.

callControlFlowsPostRESTCall

public ControlFlowElementsResponse callControlFlowsPostRESTCall(String methodName,
                                                                String urlTemplate,
                                                                Object requestBody,
                                                                Object... params)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Issue a POST REST call that returns a ControlFlowElementsResponse 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.

callProcessCallPostRESTCall

public ProcessCallElementResponse callProcessCallPostRESTCall(String methodName,
                                                              String urlTemplate,
                                                              Object requestBody,
                                                              Object... params)
                                                       throws InvalidParameterException,
                                                              UserNotAuthorizedException,
                                                              PropertyServerException

Issue a POST REST call that returns a ProcessCallElementResponse 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.

callProcessCallsPostRESTCall

public ProcessCallElementsResponse callProcessCallsPostRESTCall(String methodName,
                                                                String urlTemplate,
                                                                Object requestBody,
                                                                Object... params)
                                                         throws InvalidParameterException,
                                                                UserNotAuthorizedException,
                                                                PropertyServerException

Issue a POST REST call that returns a ProcessCallElementsResponse 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.

callLineageMappingsPostRESTCall

public LineageMappingElementsResponse callLineageMappingsPostRESTCall(String methodName,
                                                                      String urlTemplate,
                                                                      Object requestBody,
                                                                      Object... params)
                                                               throws InvalidParameterException,
                                                                      UserNotAuthorizedException,
                                                                      PropertyServerException

Issue a POST REST call that returns a LineageMappingElementsResponse 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.