Class OMFRESTClient
java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
org.odpi.openmetadata.frameworkservices.omf.client.rest.OMFRESTClient
public class OMFRESTClient
extends org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
OMFRESTClient is responsible for issuing calls to the OMAS REST APIs.
-
Constructor Summary
ConstructorsConstructorDescriptionOMFRESTClient(String serverName, String serverPlatformURLRoot) Constructor for no authentication.OMFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password) Constructor for simple userId and password authentication.OMFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) Constructor for simple userId and password authentication with audit log.OMFRESTClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) Constructor for no authentication with audit log. -
Method Summary
Modifier and TypeMethodDescriptionorg.odpi.openmetadata.frameworkservices.omf.rest.AnchorSearchMatchesListResponsecallAnchorSearchMatchesListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a AnchorSearchMatchesListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.AnchorSearchMatchesResponsecallAnchorSearchMatchesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a AnchorSearchMatchesResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.AttributeTypeDefResponsecallAttributeTypeDefGetRESTCall(String methodName, String operationSpecificURL, Object... params) Issue a GET REST call that returns a AttributeTypeDefResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.AttributeTypeDefListResponsecallAttributeTypeDefListGetRESTCall(String methodName, String operationSpecificURL, Object... params) Issue a GET REST call that returns a AttributeTypeDefListResponse object.org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponsecallBooleanGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a BooleanResponse object.org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponsecallBooleanPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a GET REST call that returns a BooleanResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.MetadataCorrelationHeadersResponsecallCorrelationHeadersPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a MetadataCorrelationHeadersResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataElementResponsecallOpenMetadataElementGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a OpenMetadataElementResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataElementResponsecallOpenMetadataElementPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a OpenMetadataElementResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataElementsResponsecallOpenMetadataElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a OpenMetadataElementsResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataGraphResponsecallOpenMetadataGraphPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a OpenMetadataGraphResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataRelationshipListResponsecallOpenMetadataRelationshipListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a OpenMetadataRelationshipListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataRelationshipResponsecallOpenMetadataRelationshipPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a OpenMetadataRelationshipResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataRelationshipResponsecallRelatedMetadataElementGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a OpenMetadataRelationshipResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.RelatedMetadataElementListResponsecallRelatedMetadataElementListGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a RelatedMetadataElementListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.RelatedMetadataElementListResponsecallRelatedMetadataElementListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) Issue a POST REST call that returns a RelatedMetadataElementListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataRelationshipListResponsecallRelatedMetadataElementsListGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a OpenMetadataRelationshipListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.TranslationDetailResponsecallTranslationDetailGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a TranslationDetailResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.TranslationListResponsecallTranslationListGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a TranslationListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefGalleryResponsecallTypeDefGalleryGetRESTCall(String methodName, String operationSpecificURL, Object... params) Issue a GET REST call that returns a TypeDefGalleryResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefResponsecallTypeDefGetRESTCall(String methodName, String operationSpecificURL, Object... params) Issue a GET REST call that returns a TypeDefResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefListResponsecallTypeDefListGetRESTCall(String methodName, String operationSpecificURL, Object... params) Issue a GET REST call that returns a TypeDefListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefListResponsecallTypeDefListPostRESTCall(String methodName, String operationSpecificURL, Object requestBody, Object... params) Issue a POST REST call that returns a TypeDefListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefResponsecallTypeDefPostRESTCall(String methodName, String operationSpecificURL, Object requestBody, Object... params) Issue a POST REST call that returns a TypeDefResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.ValidMetadataValueDetailListResponsecallValidMetadataValueDetailListGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ValidMetadataValueDetailListResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.ValidMetadataValueResponsecallValidMetadataValueGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ValidMetadataValueResponse object.org.odpi.openmetadata.frameworkservices.omf.rest.ValidMetadataValueListResponsecallValidMetadataValueListGetRESTCall(String methodName, String urlTemplate, Object... params) Issue a GET REST call that returns a ValidMetadataValueListResponse object.Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient
callActorProfileGetRESTCall, callActorProfilesGetRESTCall, callActorProfilesPostRESTCall, callAnnotationGetRESTCall, callAnnotationListGetRESTCall, callAnnotationListPostRESTCall, callAnnotationPostRESTCall, callAPIGetRESTCall, callAPIOperationGetRESTCall, callAPIOperationsGetRESTCall, callAPIOperationsPostRESTCall, callAPIParameterListGetRESTCall, callAPIParameterListsGetRESTCall, callAPIParameterListsPostRESTCall, callAPIParametersGetRESTCall, callAPIsGetRESTCall, callAPIsPostRESTCall, callAppointeesPostRESTCall, callAssetElementGetRESTCall, callAssetElementsGetRESTCall, callAssetElementsPostRESTCall, callAssetRelationshipsPostRESTCall, callCertificationTypeGetRESTCall, callCertificationTypeListGetRESTCall, callCertificationTypeListPostRESTCall, callCollectionGetRESTCall, callCollectionListGetRESTCall, callCollectionListPostRESTCall, callCollectionMemberGetRESTCall, callCollectionMemberListGetRESTCall, callCommunitiesGetRESTCall, callCommunitiesPostRESTCall, callCommunityGetRESTCall, callConnectionGetRESTCall, callConnectionsGetRESTCall, callConnectionsPostRESTCall, callConnectorTypeGetRESTCall, callConnectorTypesPostRESTCall, callControlFlowPostRESTCall, callControlFlowsPostRESTCall, callCountGetRESTCall, callDatabaseColumnGetRESTCall, callDatabaseColumnsGetRESTCall, callDatabaseColumnsPostRESTCall, callDatabaseGetRESTCall, callDatabaseSchemaGetRESTCall, callDatabaseSchemasGetRESTCall, callDatabaseSchemasPostRESTCall, callDatabasesPostRESTCall, callDatabaseTableGetRESTCall, callDatabaseTablesGetRESTCall, callDatabaseTablesPostRESTCall, callDatabaseViewGetRESTCall, callDatabaseViewsGetRESTCall, callDatabaseViewsPostRESTCall, callDataContainerGetRESTCall, callDataContainersGetRESTCall, callDataContainersPostRESTCall, callDataFileGetRESTCall, callDataFilePostRESTCall, callDataFilesGetRESTCall, callDataFilesPostRESTCall, callDataFlowPostRESTCall, callDataFlowsPostRESTCall, callDigitalServiceGetRESTCall, callDigitalServicesGetRESTCall, callDigitalServicesPostRESTCall, callDiscoveryAnalysisReportListPostRESTCall, callElementHeaderPostRESTCall, callElementHeadersPostRESTCall, callElementStubGetRESTCall, callElementStubsGetRESTCall, callElementStubsPostRESTCall, callEndpointGetRESTCall, callEndpointsGetRESTCall, callEndpointsPostRESTCall, callEventTypeGetRESTCall, callEventTypesGetRESTCall, callEventTypesPostRESTCall, callExternalReferenceGetRESTCall, callExternalReferencesGetRESTCall, callExternalReferencesPostRESTCall, callFileFolderGetRESTCall, callFileFolderPostRESTCall, callFileFoldersGetRESTCall, callFileSystemGetRESTCall, callFolderGetRESTCall, callFormGetRESTCall, callFormsGetRESTCall, callFormsPostRESTCall, callGUIDGetRESTCall, callGUIDListGetRESTCall, callGUIDListPostRESTCall, callGUIDPostRESTCall, callITProfileGetRESTCall, callITProfileListGetRESTCall, callITProfileListPostRESTCall, callLicensesGetRESTCall, callLicenseTypeGetRESTCall, callLicenseTypeListPostRESTCall, callLicenseTypesGetRESTCall, callLineageMappingPostRESTCall, callLineageMappingsPostRESTCall, callLocationGetRESTCall, callLocationsGetRESTCall, callLocationsPostRESTCall, callMetadataElementSummariesPostRESTCall, callMetadataSourceGetRESTCall, callNameListGetRESTCall, callOCFConnectorReportGetRESTCall, callPersonRoleGetRESTCall, callPersonRolesGetRESTCall, callPersonRolesPostRESTCall, callProcessCallPostRESTCall, callProcessCallsPostRESTCall, callProjectGetRESTCall, callProjectsGetRESTCall, callProjectsPostRESTCall, callQueriesGetRESTCall, callQueriesPostRESTCall, callQueryGetRESTCall, callReferenceValueAssignmentDefinitionsGetRESTCall, callReferenceValueAssignmentItemsGetRESTCall, callRelatedAssetsPostRESTCall, callRelatedElementsGetRESTCall, callRelatedElementsPostRESTCall, callRelationshipPostRESTCall, callRelationshipsPostRESTCall, callReportGetRESTCall, callReportsGetRESTCall, callReportsPostRESTCall, callSchemaAttributeGetRESTCall, callSchemaAttributePostRESTCall, callSchemaAttributesGetRESTCall, callSchemaAttributesPostRESTCall, callSchemaTypeGetRESTCall, callSchemaTypePostRESTCall, callSchemaTypesPostRESTCall, callSecurityGroupGetRESTCall, callSecurityGroupPostRESTCall, callSecurityGroupsGetRESTCall, callSecurityGroupsPostRESTCall, callServerAssetUseGetRESTCall, callServerAssetUseListGetRESTCall, callServerAssetUseListPostRESTCall, callSoftwareServerCapabilitiesGetRESTCall, callSoftwareServerCapabilitiesPostRESTCall, callSoftwareServerCapabilityGetRESTCall, callStringMapGetRESTCall, callSupportedCapabilityListPostRESTCall, callSurveyReportListGetRESTCall, callTopicGetRESTCall, callTopicsGetRESTCall, callTopicsPostRESTCall, callUserIdentitiesGetRESTCall, callUserIdentitiesPostRESTCall, callUserIdentityGetRESTCall, callUserIdentityListPostRESTCall, callUserIdentityPostRESTCall, callValidValueAssignmentConsumersGetRESTCall, callValidValueAssignmentDefinitionsGetRESTCall, callValidValueGetRESTCall, callValidValueListGetRESTCall, callValidValueListPostRESTCall, callValidValueMappingsGetRESTCall, callValidValueSetsPostRESTCall, callValidValuesGetRESTCall, callValidValuesImplAssetsGetRESTCall, callValidValuesImplDefinitionsGetRESTCall, callValidValuesMappingsGetRESTCall, callValidValuesPostRESTCall, callVoidGetRESTCall, callVoidPostRESTCallMethods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClientBase
callPostRESTCallNoParams
-
Constructor Details
-
OMFRESTClient
public OMFRESTClient(String serverName, String serverPlatformURLRoot, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- there is a problem creating the client-side components to issue any REST API calls.
-
OMFRESTClient
public OMFRESTClient(String serverName, String serverPlatformURLRoot) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- there is a problem creating the client-side components to issue any REST API calls.
-
OMFRESTClient
public OMFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password, org.odpi.openmetadata.frameworks.auditlog.AuditLog auditLog) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- there is a problem creating the client-side components to issue any REST API calls.
-
OMFRESTClient
public OMFRESTClient(String serverName, String serverPlatformURLRoot, String userId, String password) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- there is a problem creating the client-side components to issue any REST API calls.
-
-
Method Details
-
callTypeDefGalleryGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefGalleryResponse callTypeDefGalleryGetRESTCall(String methodName, String operationSpecificURL, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a TypeDefGalleryResponse object.- Parameters:
methodName- name of the method being calledoperationSpecificURL- template of the URL for the REST API call, with place-holders for the parametersparams- a list of parameters that are slotted into the url template- Returns:
- TypeDefGalleryResponseObject
- Throws:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callAttributeTypeDefListGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.AttributeTypeDefListResponse callAttributeTypeDefListGetRESTCall(String methodName, String operationSpecificURL, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a AttributeTypeDefListResponse object.- Parameters:
methodName- name of the method being calledoperationSpecificURL- template of the URL for the REST API call, with place-holders for the parametersparams- a list of parameters that are slotted into the url template- Returns:
- AttributeTypeDefListResponse
- Throws:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callAttributeTypeDefGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.AttributeTypeDefResponse callAttributeTypeDefGetRESTCall(String methodName, String operationSpecificURL, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a AttributeTypeDefResponse object.- Parameters:
methodName- name of the method being calledoperationSpecificURL- template of the URL for the REST API call, with place-holders for the parametersparams- a list of parameters that are slotted into the url template- Returns:
- AttributeTypeDefResponse
- Throws:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callTypeDefListGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefListResponse callTypeDefListGetRESTCall(String methodName, String operationSpecificURL, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a TypeDefListResponse object.- Parameters:
methodName- name of the method being calledoperationSpecificURL- template of the URL for the REST API call, with place-holders for the parametersparams- a list of parameters that are slotted into the url template- Returns:
- TypeDefListResponse
- Throws:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callTypeDefListPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefListResponse callTypeDefListPostRESTCall(String methodName, String operationSpecificURL, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a TypeDefListResponse object.- Parameters:
methodName- name of the method being calledoperationSpecificURL- template of the URL for the REST API call, with place-holders for the parametersrequestBody- request bodyparams- a list of parameters that are slotted into the url template- Returns:
- TypeDefListResponse
- Throws:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callTypeDefGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefResponse callTypeDefGetRESTCall(String methodName, String operationSpecificURL, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a TypeDefResponse object.- Parameters:
methodName- name of the method being calledoperationSpecificURL- template of the URL for the REST API call, with place-holders for the parametersparams- a list of parameters that are slotted into the url template- Returns:
- TypeDefResponse
- Throws:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callTypeDefPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.TypeDefResponse callTypeDefPostRESTCall(String methodName, String operationSpecificURL, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a TypeDefResponse object.- Parameters:
methodName- name of the method being calledoperationSpecificURL- template of the URL for the REST API call, with place-holders for the parametersrequestBody- request body objectparams- a list of parameters that are slotted into the url template- Returns:
- TypeDefResponse
- Throws:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callOpenMetadataElementsPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataElementsResponse callOpenMetadataElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a OpenMetadataElementsResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callOpenMetadataElementPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataElementResponse callOpenMetadataElementPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a OpenMetadataElementResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callAnchorSearchMatchesListPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.AnchorSearchMatchesListResponse callAnchorSearchMatchesListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a AnchorSearchMatchesListResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callAnchorSearchMatchesPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.AnchorSearchMatchesResponse callAnchorSearchMatchesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a AnchorSearchMatchesResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callOpenMetadataGraphPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataGraphResponse callOpenMetadataGraphPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a OpenMetadataGraphResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callOpenMetadataElementGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataElementResponse callOpenMetadataElementGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a OpenMetadataElementResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callOpenMetadataRelationshipListPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataRelationshipListResponse callOpenMetadataRelationshipListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a OpenMetadataRelationshipListResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callOpenMetadataRelationshipPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataRelationshipResponse callOpenMetadataRelationshipPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a OpenMetadataRelationshipResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callRelatedMetadataElementsListGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataRelationshipListResponse callRelatedMetadataElementsListGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a OpenMetadataRelationshipListResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callRelatedMetadataElementGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.OpenMetadataRelationshipResponse callRelatedMetadataElementGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a OpenMetadataRelationshipResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callRelatedMetadataElementListPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.RelatedMetadataElementListResponse callRelatedMetadataElementListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a RelatedMetadataElementListResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callRelatedMetadataElementListGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.RelatedMetadataElementListResponse callRelatedMetadataElementListGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a RelatedMetadataElementListResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callTranslationDetailGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.TranslationDetailResponse callTranslationDetailGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a TranslationDetailResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callTranslationListGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.TranslationListResponse callTranslationListGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a TranslationListResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callValidMetadataValueDetailListGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.ValidMetadataValueDetailListResponse callValidMetadataValueDetailListGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a ValidMetadataValueDetailListResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callValidMetadataValueListGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.ValidMetadataValueListResponse callValidMetadataValueListGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a ValidMetadataValueListResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callValidMetadataValueGetRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.ValidMetadataValueResponse callValidMetadataValueGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a ValidMetadataValueResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callBooleanGetRESTCall
public org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse callBooleanGetRESTCall(String methodName, String urlTemplate, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a BooleanResponse object.- Overrides:
callBooleanGetRESTCallin classorg.odpi.openmetadata.commonservices.ffdc.rest.FFDCRESTClient- 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callBooleanPostRESTCall
public org.odpi.openmetadata.commonservices.ffdc.rest.BooleanResponse callBooleanPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a GET REST call that returns a BooleanResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-
callCorrelationHeadersPostRESTCall
public org.odpi.openmetadata.frameworkservices.omf.rest.MetadataCorrelationHeadersResponse callCorrelationHeadersPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException Issue a POST REST call that returns a MetadataCorrelationHeadersResponse 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:
org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException- one of the parameters is invalid.org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException- the user is not authorized to make this request.org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException- the repository is not available or not working properly.
-