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

Class AssetManagerRESTClient

java.lang.Object

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

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

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

public class AssetManagerRESTClient
extends FFDCRESTClient

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

Field Summary

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

auditLog, exceptionHandler, serverName, serverPlatformURLRoot

Constructor Summary

Constructors

Constructor	Description
AssetManagerRESTClient(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 Type	Method	Description
CommentElementResponse	callCommentElementPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a GET REST call that returns a CommentElementResponse object.
CommentElementsResponse	callCommentElementsGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a CommentElementsResponse object.
CommentElementsResponse	callCommentElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a CommentElementsResponse object.
ExternalReferenceElementResponse	callExternalReferencePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ExternalReferenceElementResponse object.
LikeElementResponse	callLikeElementGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a LikeElementResponse object.
LikeElementsResponse	callLikeElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a LikeElementsResponse object.
AssetElementsResponse	callMyAssetsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a AssetsResponse object.
ConnectionResponse	callMyConnectionPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectionsResponse object.
ConnectionsResponse	callMyConnectionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectionsResponse object.
ConnectorTypeResponse	callMyConnectorTypePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectorTypeResponse object.
ConnectorTypesResponse	callMyConnectorTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ConnectorTypesResponse object.
MetadataCorrelationHeadersResponse	callMyCorrelationHeadersPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a MetadataCorrelationHeadersResponse object.
DataAssetElementResponse	callMyDataAssetPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DataAssetElementResponse object.
DataAssetElementsResponse	callMyDataAssetsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a DataAssetElementsResponse object.
EndpointResponse	callMyEndpointPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a EndpointResponse object.
EndpointsResponse	callMyEndpointsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a EndpointsResponse object.
ExternalGlossaryLinkElementsResponse	callMyExternalGlossaryLinksPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ExternalGlossaryLinkElementsResponse object.
ExternalReferenceLinkElementsResponse	callMyExternalReferenceLinksPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ExternalReferenceLinkElementsResponse object.
ExternalReferenceElementsResponse	callMyExternalReferencesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ExternalReferenceElementsResponse object.
GlossaryElementsResponse	callMyGlossariesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GlossaryElementsResponse object.
GlossaryCategoryElementsResponse	callMyGlossaryCategoriesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GlossaryCategoryElementsResponse object.
GlossaryCategoryElementResponse	callMyGlossaryCategoryPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GlossaryCategoryElementResponse object.
GlossaryElementResponse	callMyGlossaryPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GlossaryElementResponse object.
GlossaryTermElementResponse	callMyGlossaryTermPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GlossaryTermElementResponse object.
GlossaryTermElementsResponse	callMyGlossaryTermsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GlossaryTermElementsResponse object.
GovernanceDefinitionsResponse	callMyGovernanceDefinitionsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a GovernanceDefinitionsResponse object.
InformalTagResponse	callMyInformalTagGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a InformalTagsResponse object.
InformalTagsResponse	callMyInformalTagListPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a InformalTagsResponse object.
NoteElementResponse	callMyNoteElementPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a NoteLogElementResponse object.
NoteElementsResponse	callMyNoteElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a NoteElementsResponse object.
NoteLogElementResponse	callMyNoteLogElementPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a NoteLogElementResponse object.
NoteLogElementsResponse	callMyNoteLogElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a NoteLogElementsResponse object.
PortElementResponse	callMyPortPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a PortElementResponse object.
PortElementsResponse	callMyPortsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a PortElementsResponse object.
ProcessElementsResponse	callMyProcessesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ProcessElementsResponse object.
ProcessElementResponse	callMyProcessPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a ProcessElementResponse object.
SchemaAttributeElementResponse	callMySchemaAttributePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SchemaAttributeElementResponse object.
SchemaAttributeElementsResponse	callMySchemaAttributesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SchemaAttributeElementsResponse object.
SchemaTypeElementResponse	callMySchemaTypePostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SchemaTypeElementResponse object.
SchemaTypeElementsResponse	callMySchemaTypesPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a SchemaTypeElementsResponse object.
RatingElementResponse	callRatingElementGetRESTCall(String methodName, String urlTemplate, Object... params)	Issue a GET REST call that returns a RatingElementResponse object.
RatingElementsResponse	callRatingElementsPostRESTCall(String methodName, String urlTemplate, Object requestBody, Object... params)	Issue a POST REST call that returns a RatingElementsResponse 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, callBooleanGetRESTCall, 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, callVoidPostRESTCall

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

AssetManagerRESTClient

public AssetManagerRESTClient(String serverName,
 String serverPlatformURLRoot,
 AuditLog auditLog)
                       throws InvalidParameterException

Constructor for no authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

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

auditLog - destination for log messages.

Throws:

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

AssetManagerRESTClient

public AssetManagerRESTClient(String serverName,
 String serverPlatformURLRoot)
                       throws InvalidParameterException

Constructor for no authentication.

Parameters:

serverName - name of the OMAG Server to call

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

Throws:

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

AssetManagerRESTClient

public AssetManagerRESTClient(String serverName,
 String serverPlatformURLRoot,
 String userId,
 String password,
 AuditLog auditLog)
                       throws InvalidParameterException

Constructor for simple userId and password authentication with audit log.

Parameters:

serverName - name of the OMAG Server to call

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

userId - user id for the HTTP request

password - password for the HTTP request

auditLog - destination for log messages.

Throws:

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

AssetManagerRESTClient

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

Constructor for simple userId and password authentication.

Parameters:

serverName - name of the OMAG Server to call

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

userId - user id for the HTTP request

password - password for the HTTP request

Throws:

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

Method Details

callMyGovernanceDefinitionsPostRESTCall

public GovernanceDefinitionsResponse callMyGovernanceDefinitionsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a GovernanceDefinitionsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyConnectionsPostRESTCall

public ConnectionsResponse callMyConnectionsPostRESTCall(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 - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyConnectionPostRESTCall

public ConnectionResponse callMyConnectionPostRESTCall(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 - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyConnectorTypePostRESTCall

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

Issue a POST REST call that returns a ConnectorTypeResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyConnectorTypesPostRESTCall

public ConnectorTypesResponse callMyConnectorTypesPostRESTCall(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 - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyEndpointsPostRESTCall

public EndpointsResponse callMyEndpointsPostRESTCall(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 - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyEndpointPostRESTCall

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

Issue a POST 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 - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

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

callMyExternalReferencesPostRESTCall

public ExternalReferenceElementsResponse callMyExternalReferencesPostRESTCall(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 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.

callMyExternalReferenceLinksPostRESTCall

public ExternalReferenceLinkElementsResponse callMyExternalReferenceLinksPostRESTCall(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 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.

callMySchemaTypePostRESTCall

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

Issue a POST REST call that returns a SchemaTypeElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMySchemaTypesPostRESTCall

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

Issue a POST REST call that returns a SchemaTypeElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMySchemaAttributePostRESTCall

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

Issue a POST REST call that returns a SchemaAttributeElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMySchemaAttributesPostRESTCall

public SchemaAttributeElementsResponse callMySchemaAttributesPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a SchemaAttributeElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyInformalTagListPostRESTCall

public InformalTagsResponse callMyInformalTagListPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a InformalTagsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyInformalTagGetRESTCall

public InformalTagResponse callMyInformalTagGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                 throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callLikeElementsPostRESTCall

public LikeElementsResponse callLikeElementsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a LikeElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callLikeElementGetRESTCall

public LikeElementResponse callLikeElementGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                               throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callRatingElementsPostRESTCall

public RatingElementsResponse callRatingElementsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a RatingElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callRatingElementGetRESTCall

public RatingElementResponse callRatingElementGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                   throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callCommentElementsPostRESTCall

public CommentElementsResponse callCommentElementsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a CommentElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callCommentElementPostRESTCall

public CommentElementResponse callCommentElementPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                      throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a GET REST call that returns a CommentElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callCommentElementsGetRESTCall

public CommentElementsResponse callCommentElementsGetRESTCall(String methodName,
 String urlTemplate,
 Object... params)
                                                       throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

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

callMyNoteLogElementsPostRESTCall

public NoteLogElementsResponse callMyNoteLogElementsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                          throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a NoteLogElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyNoteLogElementPostRESTCall

public NoteLogElementResponse callMyNoteLogElementPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                        throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a NoteLogElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyNoteElementsPostRESTCall

public NoteElementsResponse callMyNoteElementsPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                    throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a NoteElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyNoteElementPostRESTCall

public NoteElementResponse callMyNoteElementPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                  throws InvalidParameterException,
UserNotAuthorizedException,
PropertyServerException

Issue a POST REST call that returns a NoteLogElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyGlossaryPostRESTCall

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

Issue a POST REST call that returns a GlossaryElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyGlossariesPostRESTCall

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

Issue a POST REST call that returns a GlossaryElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyGlossaryCategoryPostRESTCall

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

Issue a POST REST call that returns a GlossaryCategoryElementResponse object.

Parameters:

methodName - name of the method being called

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyGlossaryCategoriesPostRESTCall

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

Issue a POST REST call that returns a GlossaryCategoryElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyGlossaryTermPostRESTCall

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

Issue a POST REST call that returns a GlossaryTermElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyGlossaryTermsPostRESTCall

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

Issue a POST REST call that returns a GlossaryTermElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyExternalGlossaryLinksPostRESTCall

public ExternalGlossaryLinkElementsResponse callMyExternalGlossaryLinksPostRESTCall(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 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.

callMyCorrelationHeadersPostRESTCall

public MetadataCorrelationHeadersResponse callMyCorrelationHeadersPostRESTCall(String methodName,
 String urlTemplate,
 Object requestBody,
 Object... params)
                                                                        throws InvalidParameterException,
UserNotAuthorizedException,
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 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.

callMyDataAssetPostRESTCall

public DataAssetElementResponse callMyDataAssetPostRESTCall(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 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.

callMyDataAssetsPostRESTCall

public DataAssetElementsResponse callMyDataAssetsPostRESTCall(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 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.

callMyAssetsPostRESTCall

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

Issue a POST REST call that returns a AssetsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyPortPostRESTCall

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

Issue a POST REST call that returns a PortElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyPortsPostRESTCall

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

Issue a POST REST call that returns a PortElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyProcessPostRESTCall

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

Issue a POST REST call that returns a ProcessElementResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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

callMyProcessesPostRESTCall

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

Issue a POST REST call that returns a ProcessElementsResponse object.

Parameters:

methodName - name of the method being called.

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

requestBody - object that passes additional parameters

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

Returns:

response object

Throws:

InvalidParameterException - one of the parameters is invalid.

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

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