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

Class ITInfrastructureRESTClient

java.lang.Object

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

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

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

org.odpi.openmetadata.accessservices.itinfrastructure.client.rest.ITInfrastructureRESTClient

public class ITInfrastructureRESTClient
extends OCFRESTClient

ITInfrastructureRESTClient is responsible for issuing calls to the OMAS REST APIs.

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AssetResponse	callAssetGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns an AssetElement in a response object.
AssetListResponse	callAssetListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of AssetElements in a response object.
AssetListResponse	callAssetListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of AssetElements in a response object.
AssetResponse	callAssetPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns an asset in a response object.
AssetRelationshipListResponse	callAssetRelationshipListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of AssetRelationshipListResponse in a response object.
ConnectionResponse	callConnectionGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectionResponse object.
ConnectionsResponse	callConnectionsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a POST REST call that returns a ConnectionsResponse object.
ConnectionsResponse	callConnectionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectionsResponse object.
ConnectorTypeResponse	callConnectorTypeGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ConnectorReportResponse object.
ConnectorTypesResponse	callConnectorTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectorTypesResponse object.
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.
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.
ElementStubResponse	callElementStubGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ElementStubResponse object.
EndpointResponse	callEndpointGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EndpointResponse object.
EndpointsResponse	callEndpointsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a EndpointsResponse object.
EndpointsResponse	callEndpointsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a EndpointsResponse object.
ITProfileResponse	callITProfileGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ITProfileElement in a response object.
ITProfileListResponse	callITProfileListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of ITProfileElements in a response object.
ITProfileListResponse	callITProfileListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a list of ITProfileElements in a response object.
LineageMappingElementResponse	callLineageMappingPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a LineageMappingElementResponse object.
LineageMappingElementsResponse	callLineageMappingsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a LineageMappingElementsResponse 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.
RelatedAssetListResponse	callRelatedAssetListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of RelatedAssetElements in a response object.
ServerAssetUseResponse	callServerAssetUseGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a ServerAssetUseElement in a response object.
ServerAssetUseListResponse	callServerAssetUseListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of ServerAssetUseElements in a response object.
ServerAssetUseListResponse	callServerAssetUseListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of ServerAssetUseElements in a response object.
SoftwareCapabilityResponse	callSoftwareServerCapabilityGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a SoftwareCapabilityElement in a response object.
SoftwareCapabilityListResponse	callSoftwareServerCapabilityListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of SoftwareServerCapabilityElements in a response object.
SoftwareCapabilityListResponse	callSoftwareServerCapabilityListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of SoftwareServerCapabilityElements in a response object.
SupportedCapabilityListResponse	callSupportedCapabilityListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of SupportedCapabilityElements in a response object.
UserIdentityResponse	callUserIdentityGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a UserIdentityElement in a response object.
UserIdentityListResponse	callUserIdentityListGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a list of UserIdentityElements in a response object.
UserIdentityListResponse	callUserIdentityListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a list of UserIdentityElements in a response object.

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

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

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

ITInfrastructureRESTClient

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

ITInfrastructureRESTClient

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

ITInfrastructureRESTClient

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

ITInfrastructureRESTClient

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

Constructor for simple userId and password authentication.

Parameters:

serverName - name of the OMAG Server to call

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

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

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

Method Details

callConnectionGetRESTCall

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

Issue a GET REST call that returns a ConnectionResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

ConnectionResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callConnectionsGetRESTCall

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

Issue a POST REST call that returns a ConnectionsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

ConnectionsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callConnectionsPostRESTCall

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

Issue a POST REST call that returns a ConnectionsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - properties describing the valid value definition/set

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

Returns:

ConnectionsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callConnectorTypeGetRESTCall

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

Issue a GET REST call that returns a ConnectorReportResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

ConnectorReportResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callConnectorTypesPostRESTCall

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

Issue a POST REST call that returns a ConnectorTypesResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - properties describing the valid value definition/set

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

Returns:

ConnectorTypesResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callEndpointGetRESTCall

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

Issue a GET REST call that returns a EndpointResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

EndpointResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callEndpointsGetRESTCall

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

Issue a GET REST call that returns a EndpointsResponse object.

Parameters:

methodName - name of the method being called.

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

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

Returns:

EndpointsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callEndpointsPostRESTCall

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

Issue a POST REST call that returns a EndpointsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - properties describing the valid value definition/set

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

Returns:

EndpointsResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

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.

callITProfileGetRESTCall

public ITProfileResponse callITProfileGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callITProfileListGetRESTCall

public ITProfileListResponse callITProfileListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callITProfileListPostRESTCall

public ITProfileListResponse callITProfileListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a list of ITProfileElements in a response 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 - request body for the request

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callUserIdentityGetRESTCall

public UserIdentityResponse callUserIdentityGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a UserIdentityElement in a response 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:

UserIdentityResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callUserIdentityListGetRESTCall

public UserIdentityListResponse callUserIdentityListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                         throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a list of UserIdentityElements in a response 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:

UserIdentityListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callUserIdentityListPostRESTCall

public UserIdentityListResponse callUserIdentityListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a list of UserIdentityElements in a response 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 - request body for the request

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

Returns:

UserIdentityListResponse

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callSoftwareServerCapabilityGetRESTCall

public SoftwareCapabilityResponse callSoftwareServerCapabilityGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callSoftwareServerCapabilityListGetRESTCall

public SoftwareCapabilityListResponse callSoftwareServerCapabilityListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a list of SoftwareServerCapabilityElements in a response 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 objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callSoftwareServerCapabilityListPostRESTCall

public SoftwareCapabilityListResponse callSoftwareServerCapabilityListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a list of SoftwareServerCapabilityElements in a response 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 - request body for the request

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

Returns:

response objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callAssetGetRESTCall

public AssetResponse callAssetGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callAssetPostRESTCall

public AssetResponse callAssetPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns an asset in a response 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 - request body for the request

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callAssetListGetRESTCall

public AssetListResponse callAssetListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                           throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a list of AssetElements in a response 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 objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callAssetListPostRESTCall

public AssetListResponse callAssetListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                            throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a list of AssetElements in a response 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 - request body for the request

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

Returns:

response objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callAssetRelationshipListPostRESTCall

public AssetRelationshipListResponse callAssetRelationshipListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a list of AssetRelationshipListResponse in a response 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 - request body for the request

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

Returns:

response objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callRelatedAssetListPostRESTCall

public RelatedAssetListResponse callRelatedAssetListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a list of RelatedAssetElements in a response 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 - request body for the request

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

Returns:

response objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callServerAssetUseGetRESTCall

public ServerAssetUseResponse callServerAssetUseGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                     throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callServerAssetUseListGetRESTCall

public ServerAssetUseListResponse callServerAssetUseListGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a list of ServerAssetUseElements in a response 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 objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callServerAssetUseListPostRESTCall

public ServerAssetUseListResponse callServerAssetUseListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                              throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a list of ServerAssetUseElements in a response 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 - request body for the request

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

Returns:

response objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

callSupportedCapabilityListPostRESTCall

public SupportedCapabilityListResponse callSupportedCapabilityListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a list of SupportedCapabilityElements in a response 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 - request body for the request

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

Returns:

response objects

Throws:

InvalidParameterException - one of the parameters is invalid.

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

PropertyServerException - something went wrong with the REST call stack.

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.

callLineageMappingPostRESTCall

public LineageMappingElementResponse callLineageMappingPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                             throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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