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
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
ConstructorsConstructorDescriptionAssetManagerRESTClient
(String serverName, String serverPlatformURLRoot) Constructor for no authentication.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.AssetManagerRESTClient
(String serverName, String serverPlatformURLRoot, AuditLog auditLog) Constructor for no authentication with audit log. -
Method Summary
Modifier and TypeMethodDescriptioncallConnectionGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ConnectionResponse object.callConnectionPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ConnectionResponse object.callConnectionsGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a POST REST call that returns a ConnectionsResponse object.callConnectionsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ConnectionsResponse object.callConnectorTypePostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ConnectorReportResponse object.callConnectorTypesPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ConnectorTypesResponse object.callControlFlowPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ControlFlowElementResponse object.callControlFlowsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ControlFlowElementsResponse object.callDataAssetPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a DataAssetElementResponse object.callDataAssetsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a DataAssetElementsResponse object.callDataFlowPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a DataFlowElementResponse object.callDataFlowsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a DataFlowElementsResponse object.callElementHeaderPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ElementHeaderResponse object.callElementHeadersPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ElementHeadersResponse object.callEndpointPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a GET REST call that returns a EndpointResponse object.callEndpointsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a EndpointsResponse object.callExternalGlossaryLinksPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ExternalGlossaryLinkElementsResponse object.callExternalReferenceLinksPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ExternalReferenceLinkElementsResponse object.callExternalReferencePostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ExternalReferenceElementResponse object.callExternalReferencesPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ExternalReferenceElementsResponse object.callGlossariesPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryElementsResponse object.callGlossaryCategoriesPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryCategoryElementsResponse object.callGlossaryCategoryPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryCategoryElementResponse object.callGlossaryPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryElementResponse object.callGlossaryTermPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryTermElementResponse object.callGlossaryTermsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GlossaryTermElementsResponse object.callGovernanceActionGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a GovernanceActionElementResponse object.callGovernanceActionProcessElementsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GovernanceActionProcessElementsResponse object.callGovernanceActionProcessesGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a GovernanceActionProcessElementsResponse object.callGovernanceActionProcessGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a GovernanceActionProcessElementResponse object.callGovernanceActionsGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a GovernanceActionElementsResponse object.callGovernanceActionTypeElementsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a GovernanceActionTypeElementsResponse object.callGovernanceActionTypeGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a GovernanceActionTypeElementResponse object.callGovernanceActionTypesGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a GovernanceActionTypeElementsResponse object.callLineageMappingPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a LineageMappingElementResponse object.callLineageMappingsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a LineageMappingElementsResponse object.callNextGovernanceActionTypesGetRESTCall
(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a NextGovernanceActionTypeElementsResponse object.callPortPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a PortElementResponse object.callPortsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a PortElementsResponse object.callProcessCallPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ProcessCallElementResponse object.callProcessCallsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ProcessCallElementsResponse object.callProcessesPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ProcessElementsResponse object.callProcessPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a ProcessElementResponse object.callRelationshipPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a RelationshipElementResponse object.callRelationshipsPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a RelationshipElementsResponse object.callSchemaAttributePostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SchemaAttributeElementResponse object.callSchemaAttributesPostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SchemaAttributeElementsResponse object.callSchemaTypePostRESTCall
(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a SchemaTypeElementResponse object.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, 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
-
Constructor Details
-
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 callserverPlatformURLRoot
- 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 callserverPlatformURLRoot
- 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 callserverPlatformURLRoot
- URL root of the server manager where the OMAG Server is running.userId
- user id for the HTTP requestpassword
- password for the HTTP requestauditLog
- 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 callserverPlatformURLRoot
- URL root of the server manager where the OMAG Server is running.userId
- user id for the HTTP requestpassword
- password for the HTTP request- Throws:
InvalidParameterException
- there is a problem creating the client-side components to issue any REST API calls.
-
-
Method Details
-
callExternalReferencePostRESTCall
public ExternalReferenceElementResponse callExternalReferencePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a ExternalReferenceElementResponse 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 parametersparams
- 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.
-
callExternalReferencesPostRESTCall
public ExternalReferenceElementsResponse callExternalReferencesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a ExternalReferenceElementsResponse 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 parametersparams
- 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.
-
callExternalReferenceLinksPostRESTCall
public ExternalReferenceLinkElementsResponse callExternalReferenceLinksPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a ExternalReferenceLinkElementsResponse 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 parametersparams
- 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.
-
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 parametersparams
- 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 parametersparams
- 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 calledurlTemplate
- template of the URL for the REST API call with place-holders for the parametersrequestBody
- object that passes additional parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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.
-
callExternalGlossaryLinksPostRESTCall
public ExternalGlossaryLinkElementsResponse callExternalGlossaryLinksPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST 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.requestBody
- object that passes additional parametersparams
- 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 parametersparams
- 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 parametersparams
- 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.
-
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.
-
callConnectionPostRESTCall
public ConnectionResponse callConnectionPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST 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.requestBody
- properties describing the valid value definition/setparams
- 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.
-
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/setparams
- 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.
-
callConnectorTypePostRESTCall
public ConnectorTypeResponse callConnectorTypePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST 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.requestBody
- properties describing the valid value definition/setparams
- 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/setparams
- 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.
-
callEndpointPostRESTCall
public EndpointResponse callEndpointPostRESTCall(String methodName, String urlTemplate, Object requestBody, 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.requestBody
- properties describing the valid value definition/setparams
- 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.
-
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/setparams
- 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.
-
callDataAssetPostRESTCall
public DataAssetElementResponse callDataAssetPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a DataAssetElementResponse 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 parametersparams
- 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 DataAssetElementsResponse callDataAssetsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a DataAssetElementsResponse 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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.
-
callRelationshipPostRESTCall
public RelationshipElementResponse callRelationshipPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a RelationshipElementResponse 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 parametersparams
- 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.
-
callRelationshipsPostRESTCall
public RelationshipElementsResponse callRelationshipsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a RelationshipElementsResponse 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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 parametersparams
- 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.
-
callGovernanceActionGetRESTCall
public GovernanceActionElementResponse callGovernanceActionGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a GovernanceActionElementResponse 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.
-
callGovernanceActionsGetRESTCall
public GovernanceActionElementsResponse callGovernanceActionsGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a GovernanceActionElementsResponse 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.
-
callGovernanceActionTypeGetRESTCall
public GovernanceActionTypeElementResponse callGovernanceActionTypeGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a GovernanceActionTypeElementResponse 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.
-
callGovernanceActionTypesGetRESTCall
public GovernanceActionTypeElementsResponse callGovernanceActionTypesGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a GovernanceActionTypeElementsResponse 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.
-
callGovernanceActionTypeElementsPostRESTCall
public GovernanceActionTypeElementsResponse callGovernanceActionTypeElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a GovernanceActionTypeElementsResponse 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 parametersparams
- 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.
-
callNextGovernanceActionTypesGetRESTCall
public NextGovernanceActionTypeElementsResponse callNextGovernanceActionTypesGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a NextGovernanceActionTypeElementsResponse 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.
-
callGovernanceActionProcessGetRESTCall
public GovernanceActionProcessElementResponse callGovernanceActionProcessGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a GovernanceActionProcessElementResponse 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.
-
callGovernanceActionProcessesGetRESTCall
public GovernanceActionProcessElementsResponse callGovernanceActionProcessesGetRESTCall(String methodName, String urlTemplate, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a GET REST call that returns a GovernanceActionProcessElementsResponse 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.
-
callGovernanceActionProcessElementsPostRESTCall
public GovernanceActionProcessElementsResponse callGovernanceActionProcessElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException Issue a POST REST call that returns a GovernanceActionProcessElementsResponse 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 parametersparams
- 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.
-