java.lang.Object

org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

org.odpi.openmetadata.integrationservices.api.connector.APIIntegratorContext

public class APIIntegratorContext extends IntegrationContext

APIIntegratorContext is the context for managing resources from a relational api server.

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
actionControlInterface, connectorName, externalSourceGUID, externalSourceIsHome, externalSourceName, fileClassifier, governanceConfiguration, integrationConnectorGUID, integrationReportWriter, maxPageSize, openIntegrationClient, openMetadataStoreClient, permittedSynchronization, propertyHelper, userId
Constructor Summary

Constructors

Constructor

Description

APIIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, APIManagerClient apiManagerClient, ConnectionManagerClient connectionManagerClient, ValidValueManagement validValueManagement, DataManagerEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, AuditLog auditLog, int maxPageSize)

Create a new client with no authentication embedded in the HTTP request.
Method Summary

Modifier and Type

Method

Description

void

clearReferenceValueTag(String elementGUID, String validValueGUID)

Remove a reference value assignment relationship between an element and a valid value.

void

clearSchemaElementRelationship(String endOneGUID, String endTwoGUID, String relationshipTypeName)

Remove a relationship between two schema elements.

void

clearSchemaTypes(String apiParameterGUID)

Remove the linked schema types from an API parameter.

void

clearValidValueMember(String validValueSetGUID, String validValueMemberGUID)

Remove a membership relationship between a validValue and a validValueSet that it belongs to.

void

clearValidValues(String elementGUID, String validValueGUID)

Remove a valid value assignment relationship between an element and a valid value.

String

createAPI(String endpointGUID, APIProperties apiProperties)

Create a new metadata element to represent an API.

String

createAPIFromTemplate(String endpointGUID, String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent an API using an existing metadata element as a template.

String

createAPIOperation(String apiGUID, APIOperationProperties apiOperationProperties)

Create a new metadata element to represent an API operation.

String

createAPIOperationFromTemplate(String templateGUID, String apiGUID, TemplateProperties templateProperties)

Create a new metadata element to represent an API operation using an existing metadata element as a template.

String

createAPIParameter(String schemaElementGUID, APIParameterProperties apiParameterProperties)

Create a new metadata element to represent a API parameter.

String

createAPIParameterFromTemplate(String schemaElementGUID, String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent a API parameter using an existing metadata element as a template.

String

createAPIParameterList(String apiOperationGUID, APIParameterListType parameterListType, APIParameterListProperties properties)

Create a new metadata element to represent an API Operation's Parameter list.

String

createAPIParameterListFromTemplate(String templateGUID, String apiOperationGUID, APIParameterListType parameterListType, TemplateProperties templateProperties)

Create a new metadata element to represent an API Parameter List using an existing API Parameter List as a template.

String

createEndpoint(EndpointProperties endpointProperties)

Create a new metadata element to represent an endpoint

String

createEndpointFromTemplate(String networkAddress, String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent a endpoint using an existing metadata element as a template.

String

createEnumSchemaType(EnumSchemaTypeProperties schemaTypeProperties, String validValuesSetGUID)

Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.

String

createLiteralSchemaType(LiteralSchemaTypeProperties schemaTypeProperties)

Create a new metadata element to represent a schema type that has a fixed value.

String

createMapSchemaType(MapSchemaTypeProperties schemaTypeProperties, String mapFromSchemaTypeGUID, String mapToSchemaTypeGUID)

Create a new metadata element to represent a schema type.

String

createPrimitiveSchemaType(PrimitiveSchemaTypeProperties schemaTypeProperties)

Create a new metadata element to represent a primitive schema type such as a string, integer or character.

String

createSchemaTypeChoice(SchemaTypeChoiceProperties schemaTypeProperties, List<String> schemaTypeOptionGUIDs)

Create a new metadata element to represent a list of possible schema types that can be used for the attached API parameter.

String

createSchemaTypeFromTemplate(String templateGUID, TemplateProperties templateProperties)

Create a new metadata element to represent a schema type using an existing metadata element as a template.

String

createStructSchemaType(StructSchemaTypeProperties schemaTypeProperties)

Create a new metadata element to represent a schema type.

String

createValidValue(ValidValueProperties validValueProperties)

Create a new metadata element to represent a valid value.

List<APIOperationElement>

findAPIOperations(String searchString, int startFrom, int pageSize)

Retrieve the list of API operation metadata elements that contain the search string.

List<APIParameterListElement>

findAPIParameterLists(String searchString, int startFrom, int pageSize)

Retrieve the list of API Parameter List metadata elements that contain the search string.

List<APIParameterElement>

findAPIParameters(String searchString, String typeName, int startFrom, int pageSize)

Retrieve the list of API parameter metadata elements that contain the search string.

List<APIElement>

findAPIs(String searchString, int startFrom, int pageSize)

Retrieve the list of API metadata elements that contain the search string.

List<EndpointElement>

findEndpoints(String searchString, int startFrom, int pageSize)

Retrieve the list of endpoint metadata elements that contain the search string.

List<SchemaTypeElement>

findSchemaType(String searchString, String typeName, int startFrom, int pageSize)

Retrieve the list of schema type metadata elements that contain the search string.

List<ValidValueElement>

findValidValues(String searchString, int startFrom, int pageSize)

Retrieve the list of metadata elements that contain the search string.

List<ValidValueSetElement>

findValidValueSet(String searchString, int startFrom, int pageSize)

Retrieve the list of valid value set metadata elements that contain the search string.

List<ValidValueElement>

getAllValidValues(int startFrom, int pageSize)

Retrieve the list of valid values.

APIElement

getAPIByGUID(String guid)

Retrieve the API metadata element with the supplied unique identifier.

String

getAPIManagerName()

Return the qualified name of the API manager that is supplied in the configuration document.

APIOperationElement

getAPIOperationByGUID(String guid)

Retrieve the API operation metadata element with the supplied unique identifier.

List<APIOperationElement>

getAPIOperationsByName(String name, int startFrom, int pageSize)

Retrieve the list of API operation metadata elements with a matching qualified or display name.

APIParameterElement

getAPIParameterByGUID(String apiParameterGUID)

Retrieve the API parameter metadata element with the supplied unique identifier.

APIParameterListElement

getAPIParameterListByGUID(String guid)

Retrieve the API Parameter List metadata element with the supplied unique identifier.

List<APIParameterListElement>

getAPIParameterListsByName(String name, int startFrom, int pageSize)

Retrieve the list of API Parameter List metadata elements with a matching qualified or display name.

List<APIParameterElement>

getAPIParametersByName(String name, String typeName, int startFrom, int pageSize)

Retrieve the list of API parameter metadata elements with a matching qualified or display name.

List<APIElement>

getAPIsByName(String name, int startFrom, int pageSize)

Retrieve the list of API metadata elements with a matching qualified or display name.

List<RelatedElement>

getAssigneesOfReferenceValue(String validValueGUID, int startFrom, int pageSize)

Return information about the person roles linked to a validValue.

List<RelatedElement>

getConsumersOfValidValue(String validValueGUID, int startFrom, int pageSize)

Return information about the consumers linked to a validValue.

EndpointElement

getEndpointByGUID(String endpointGUID)

Retrieve the endpoint metadata element with the supplied unique identifier.

List<EndpointElement>

getEndpointsByName(String name, int startFrom, int pageSize)

Retrieve the list of endpoint metadata elements with a matching qualified or display name.

List<APIElement>

getMyAPIs(int startFrom, int pageSize)

Retrieve the list of apis created by this caller.

List<APIParameterElement>

getNestedAPIParameters(String parentElementGUID, int startFrom, int pageSize)

Retrieve the list of API parameters associated with a parameter list or nested underneath another parameter.

List<APIOperationElement>

getOperationsForAPI(String apiGUID, int startFrom, int pageSize)

Return the list of operations associated with an API.

List<APIParameterListElement>

getParameterListsForAPIOperation(String apiOperationGUID, int startFrom, int pageSize)

Return the list of API Parameter Lists associated with an API Operation.

List<ValidValueElement>

getReferenceValues(String elementGUID, int startFrom, int pageSize)

Return information about the valid values linked as reference value tags to an element.

SchemaTypeElement

getSchemaTypeByGUID(String schemaTypeGUID)

Retrieve the schema type metadata element with the supplied unique identifier.

List<SchemaTypeElement>

getSchemaTypeByName(String name, String typeName, int startFrom, int pageSize)

Retrieve the list of schema type metadata elements with a matching qualified or display name.

SchemaTypeElement

getSchemaTypeForElement(String parentElementGUID, String parentElementTypeName)

Return the schema type associated with a specific open metadata element (data asset, process or port).

ElementHeader

getSchemaTypeParent(String schemaTypeGUID)

Retrieve the header of the metadata element connected to a schema type.

List<ValidValueElement>

getSetsForValidValue(String validValueGUID, int startFrom, int pageSize)

Page through the list of valid value sets that a valid value definition/set belongs to.

ValidValueElement

getValidValueByGUID(String validValueGUID)

Retrieve the metadata element with the supplied unique identifier.

List<ValidValueElement>

getValidValuesByName(String name, int startFrom, int pageSize)

Retrieve the list of metadata elements with a matching qualified or display name.

List<ValidValueSetElement>

getValidValueSetByName(String name, int startFrom, int pageSize)

Retrieve the list of valid value set metadata elements with a matching qualified or display name.

List<ValidValueElement>

getValidValueSetMembers(String validValueSetGUID, int startFrom, int pageSize)

Page through the members of a valid value set.

ValidValueElement

getValidValuesForConsumer(String elementGUID)

Return information about the valid value set linked to an element as its set of valid values.

void

publishAPI(String apiGUID)

Update the zones for the API asset so that it becomes visible to consumers.

void

registerListener(DataManagerEventListener listener)

Register a listener object that will be passed each of the events published by the Data Manager OMAS.

void

removeAPI(String apiGUID, String qualifiedName)

Remove the metadata element representing an API.

void

removeAPIOperation(String apiOperationGUID, String qualifiedName)

Remove the metadata element representing an API operation.

void

removeAPIParameter(String apiParameterGUID)

Remove the metadata element representing a API parameter.

void

removeAPIParameterList(String apiParameterListGUID, String qualifiedName)

Remove an API Parameter List and all of its parameters.

void

removeEndpoint(String endpointGUID)

Remove the metadata element representing an endpoint.

void

removeSchemaType(String schemaTypeGUID)

Remove the metadata element representing a schema type.

void

removeValidValue(String validValueGUID)

Remove the metadata element representing a valid value.

void

setAPIManagerIsHome(boolean apiManagerIsHome)

Set up the flag that controls the ownership of metadata created for this API manager.

void

setupReferenceValueTag(String elementGUID, ReferenceValueAssignmentProperties properties, String validValueGUID)

Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.

void

setupSchemaElementRelationship(String endOneGUID, String endTwoGUID, String relationshipTypeName, RelationshipProperties properties)

Create a relationship between two schema elements.

void

setupSchemaType(String relationshipTypeName, String apiParameterGUID, String schemaTypeGUID)

Connect a schema type to an API parameter.

void

setupValidValueMember(String validValueSetGUID, ValidValueMembershipProperties properties, String validValueMemberGUID)

Create a membership relationship between a validValue and a validValueSet that it belongs to.

void

setupValidValues(String elementGUID, ValidValueAssignmentProperties properties, String validValueGUID)

Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.

void

updateAPI(String apiGUID, boolean isMergeUpdate, APIProperties apiProperties)

Update the metadata element representing an API.

void

updateAPIOperation(String apiOperationGUID, boolean isMergeUpdate, APIOperationProperties apiOperationProperties)

Update the metadata element representing an API operation.

void

updateAPIParameter(String apiParameterGUID, boolean isMergeUpdate, APIParameterProperties apiParameterProperties)

Update the properties of the metadata element representing an API parameter.

void

updateAPIParameterList(String apiParameterListGUID, boolean isMergeUpdate, APIParameterListProperties properties)

Update the metadata element representing an API Parameter List.

void

updateEndpoint(boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties)

Update the metadata element representing an endpoint.

void

updateSchemaType(String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties)

Update the metadata element representing a schema type.

void

updateValidValue(String validValueGUID, boolean isMergeUpdate, ValidValueProperties validValueProperties)

Update the metadata element representing a valid value.

void

withdrawAPI(String apiGUID)

Update the zones for the API asset so that it is no longer visible to consumers.

Methods inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext
addCatalogTarget, addCatalogTarget, disconnect, elementShouldBeCatalogued, getAnchorGUID, getAnchorGUID, getCatalogTarget, getCatalogTargets, getCatalogTargets, getConnectedAssetContext, getExternalSourceIsHome, getFileClassifier, getIntegrationGovernanceContext, getMaxPageSize, getMetadataSourceGUID, getMetadataSourceQualifiedName, getMyUserId, getPermittedSynchronization, isRefreshInProgress, isTypeOf, isTypeOf, registerDirectoryListener, registerDirectoryTreeListener, registerFileListener, removeCatalogTarget, reportAnchorGUID, reportAnchorGUID, reportElementCreation, reportElementDelete, reportElementUpdate, reportParentGUID, setActiveReportPublishing, setExternalSourceIsHome, setMetadataSourceQualifiedName, setMetadataSourceQualifiedName, unregisterDirectoryListener, unregisterDirectoryTreeListener, unregisterFileListener, updateCatalogTarget

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- APIIntegratorContext
  
  public APIIntegratorContext(String connectorId, String connectorName, String connectorUserId, String serverName, OpenIntegrationClient openIntegrationClient, GovernanceConfiguration governanceConfiguration, OpenMetadataClient openMetadataStoreClient, ActionControlInterface actionControlInterface, APIManagerClient apiManagerClient, ConnectionManagerClient connectionManagerClient, ValidValueManagement validValueManagement, DataManagerEventClient eventClient, boolean generateIntegrationReport, PermittedSynchronization permittedSynchronization, String integrationConnectorGUID, String externalSourceGUID, String externalSourceName, AuditLog auditLog, int maxPageSize)
  
  Create a new client with no authentication embedded in the HTTP request.
  
  Parameters:
  
  connectorId - unique identifier of the connector (used to configure the event listener)
  
  connectorName - name of connector from config
  
  connectorUserId - userId for the connector
  
  serverName - name of the integration daemon
  
  openIntegrationClient - client for calling the metadata server
  
  governanceConfiguration - client for managing catalog targets
  
  openMetadataStoreClient - client for calling the metadata server
  
  actionControlInterface - client for initiating governance actions
  
  apiManagerClient - client to map request to
  
  connectionManagerClient - client to manage connections in the metadata server
  
  validValueManagement - client for managing valid value sets and definitions
  
  eventClient - client to register for events
  
  generateIntegrationReport - should an integration report be generated?
  
  permittedSynchronization - the direction of integration permitted by the integration connector
  
  integrationConnectorGUID - unique identifier for the integration connector if it is started via an integration group (otherwise it is null).
  
  externalSourceGUID - unique identifier of the software server capability for the api manager
  
  externalSourceName - unique name of the software server capability for the api manager
  
  auditLog - logging destination
  
  maxPageSize - max number of elements that can be returned on a query
Method Details
- getAPIManagerName
  
  public String getAPIManagerName()
  
  Return the qualified name of the API manager that is supplied in the configuration document.
  
  Returns:
  
  string name
- setAPIManagerIsHome
  
  public void setAPIManagerIsHome(boolean apiManagerIsHome)
  
  Set up the flag that controls the ownership of metadata created for this API manager. Default is true.
  
  Parameters:
  
  apiManagerIsHome - should the API metadata be marked as owned by the API manager so others can not update?
- registerListener
  
  public void registerListener(DataManagerEventListener listener) throws InvalidParameterException, ConnectionCheckedException, ConnectorCheckedException, PropertyServerException, UserNotAuthorizedException
  
  Register a listener object that will be passed each of the events published by the Data Manager OMAS.
  
  Parameters:
  
  listener - listener object
  
  Throws:
  
  InvalidParameterException - one of the parameters is null or invalid.
  
  ConnectionCheckedException - there are errors in the configuration of the connection which is preventing the creation of a connector.
  
  ConnectorCheckedException - there are errors in the initialization of the connector.
  
  PropertyServerException - there is a problem retrieving information from the property server(s).
  
  UserNotAuthorizedException - the requesting user is not authorized to issue this request.
- createEndpoint
  
  public String createEndpoint(EndpointProperties endpointProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an endpoint
  
  Parameters:
  
  endpointProperties - properties about the endpoint to store
  
  Returns:
  
  unique identifier of the new endpoint
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createEndpointFromTemplate
  
  public String createEndpointFromTemplate(String networkAddress, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a endpoint using an existing metadata element as a template.
  
  Parameters:
  
  networkAddress - location of the endpoint
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - descriptive properties that override the template
  
  Returns:
  
  unique identifier of the new endpoint
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateEndpoint
  
  public void updateEndpoint(boolean isMergeUpdate, String endpointGUID, EndpointProperties endpointProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an endpoint. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  endpointGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  endpointProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeEndpoint
  
  public void removeEndpoint(String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing an endpoint.
  
  Parameters:
  
  endpointGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findEndpoints
  
  public List<EndpointElement> findEndpoints(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of endpoint metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getEndpointsByName
  
  public List<EndpointElement> getEndpointsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of endpoint metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getEndpointByGUID
  
  public EndpointElement getEndpointByGUID(String endpointGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the endpoint metadata element with the supplied unique identifier.
  
  Parameters:
  
  endpointGUID - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAPI
  
  public String createAPI(String endpointGUID, APIProperties apiProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an API.
  
  Parameters:
  
  endpointGUID - unique identifier of the endpoint where this API is located
  
  apiProperties - properties to store
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAPIFromTemplate
  
  public String createAPIFromTemplate(String endpointGUID, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an API using an existing metadata element as a template.
  
  Parameters:
  
  endpointGUID - unique identifier of the endpoint where this API is located
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateAPI
  
  public void updateAPI(String apiGUID, boolean isMergeUpdate, APIProperties apiProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an API.
  
  Parameters:
  
  apiGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  apiProperties - new properties for this element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- publishAPI
  
  public void publishAPI(String apiGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the API asset so that it becomes visible to consumers. (The zones are set to the list of zones in the publishedZones option configured for each instance of the Data Manager OMAS).
  
  Parameters:
  
  apiGUID - unique identifier of the metadata element to publish
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- withdrawAPI
  
  public void withdrawAPI(String apiGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the zones for the API asset so that it is no longer visible to consumers. (The zones are set to the list of zones in the defaultZones option configured for each instance of the Data Manager OMAS. This is the setting when the API is first created).
  
  Parameters:
  
  apiGUID - unique identifier of the metadata element to withdraw
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeAPI
  
  public void removeAPI(String apiGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing an API.
  
  Parameters:
  
  apiGUID - unique identifier of the metadata element to remove
  
  qualifiedName - unique name of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findAPIs
  
  public List<APIElement> findAPIs(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAPIsByName
  
  public List<APIElement> getAPIsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getMyAPIs
  
  public List<APIElement> getMyAPIs(int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of apis created by this caller.
  
  Parameters:
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAPIByGUID
  
  public APIElement getAPIByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the API metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAPIOperation
  
  public String createAPIOperation(String apiGUID, APIOperationProperties apiOperationProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an API operation.
  
  Parameters:
  
  apiGUID - unique identifier of the API where the operation is located
  
  apiOperationProperties - properties about the API operation
  
  Returns:
  
  unique identifier of the new API operation
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAPIOperationFromTemplate
  
  public String createAPIOperationFromTemplate(String templateGUID, String apiGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an API operation using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  apiGUID - unique identifier of the API where the operation is located
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new API operation
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateAPIOperation
  
  public void updateAPIOperation(String apiOperationGUID, boolean isMergeUpdate, APIOperationProperties apiOperationProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an API operation.
  
  Parameters:
  
  apiOperationGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  apiOperationProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeAPIOperation
  
  public void removeAPIOperation(String apiOperationGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing an API operation.
  
  Parameters:
  
  apiOperationGUID - unique identifier of the metadata element to remove
  
  qualifiedName - unique name of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findAPIOperations
  
  public List<APIOperationElement> findAPIOperations(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API operation metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getOperationsForAPI
  
  public List<APIOperationElement> getOperationsForAPI(String apiGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of operations associated with an API.
  
  Parameters:
  
  apiGUID - unique identifier of the API to query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of metadata elements describing the operations associated with the requested api
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAPIOperationsByName
  
  public List<APIOperationElement> getAPIOperationsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API operation metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAPIOperationByGUID
  
  public APIOperationElement getAPIOperationByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the API operation metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAPIParameterList
  
  public String createAPIParameterList(String apiOperationGUID, APIParameterListType parameterListType, APIParameterListProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an API Operation's Parameter list. This describes the structure of the payload supported by the API's operation. The structure of this API Operation is added using API Parameter API parameters. These parameters can have a simple type or a nested structure.
  
  Parameters:
  
  apiOperationGUID - unique identifier of an APIOperation
  
  parameterListType - is this is a header, request of response
  
  properties - properties about the API parameter list
  
  Returns:
  
  unique identifier of the new API parameter list
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAPIParameterListFromTemplate
  
  public String createAPIParameterListFromTemplate(String templateGUID, String apiOperationGUID, APIParameterListType parameterListType, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent an API Parameter List using an existing API Parameter List as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  apiOperationGUID - unique identifier of the API where the API Operation is located
  
  parameterListType - is this is a header, request of response
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new API Parameter List
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateAPIParameterList
  
  public void updateAPIParameterList(String apiParameterListGUID, boolean isMergeUpdate, APIParameterListProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing an API Parameter List.
  
  Parameters:
  
  apiParameterListGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - are unspecified properties unchanged (true) or removed?
  
  properties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeAPIParameterList
  
  public void removeAPIParameterList(String apiParameterListGUID, String qualifiedName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove an API Parameter List and all of its parameters.
  
  Parameters:
  
  apiParameterListGUID - unique identifier of the metadata element to remove
  
  qualifiedName - unique name of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findAPIParameterLists
  
  public List<APIParameterListElement> findAPIParameterLists(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API Parameter List metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getParameterListsForAPIOperation
  
  public List<APIParameterListElement> getParameterListsForAPIOperation(String apiOperationGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the list of API Parameter Lists associated with an API Operation.
  
  Parameters:
  
  apiOperationGUID - unique identifier of the API Operation to query
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of metadata elements describing the API Parameter Lists associated with the requested API Operation
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAPIParameterListsByName
  
  public List<APIParameterListElement> getAPIParameterListsByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API Parameter List metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAPIParameterListByGUID
  
  public APIParameterListElement getAPIParameterListByGUID(String guid) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the API Parameter List metadata element with the supplied unique identifier.
  
  Parameters:
  
  guid - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAPIParameter
  
  public String createAPIParameter(String schemaElementGUID, APIParameterProperties apiParameterProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a API parameter.
  
  Parameters:
  
  schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the API parameter is nested underneath
  
  apiParameterProperties - properties for the API parameter
  
  Returns:
  
  unique identifier of the new metadata element for the API parameter
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createAPIParameterFromTemplate
  
  public String createAPIParameterFromTemplate(String schemaElementGUID, String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a API parameter using an existing metadata element as a template.
  
  Parameters:
  
  schemaElementGUID - unique identifier of the schemaType or Schema Attribute where the API parameter is connected to
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new metadata element for the API parameter
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupSchemaType
  
  public void setupSchemaType(String relationshipTypeName, String apiParameterGUID, String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Connect a schema type to an API parameter.
  
  Parameters:
  
  relationshipTypeName - name of relationship to create
  
  apiParameterGUID - unique identifier of the API parameter
  
  schemaTypeGUID - unique identifier of the schema type to connect
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearSchemaTypes
  
  public void clearSchemaTypes(String apiParameterGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the linked schema types from an API parameter.
  
  Parameters:
  
  apiParameterGUID - unique identifier of the API parameter
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateAPIParameter
  
  public void updateAPIParameter(String apiParameterGUID, boolean isMergeUpdate, APIParameterProperties apiParameterProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the properties of the metadata element representing an API parameter.
  
  Parameters:
  
  apiParameterGUID - unique identifier of the API parameter to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  apiParameterProperties - new properties for the API parameter
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeAPIParameter
  
  public void removeAPIParameter(String apiParameterGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a API parameter.
  
  Parameters:
  
  apiParameterGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findAPIParameters
  
  public List<APIParameterElement> findAPIParameters(String searchString, String typeName, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API parameter metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  typeName - optional type name for the API parameter - used to restrict the search results
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getNestedAPIParameters
  
  public List<APIParameterElement> getNestedAPIParameters(String parentElementGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API parameters associated with a parameter list or nested underneath another parameter.
  
  Parameters:
  
  parentElementGUID - unique identifier of the element of interest
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of associated metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAPIParametersByName
  
  public List<APIParameterElement> getAPIParametersByName(String name, String typeName, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of API parameter metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  typeName - optional type name for the schema type - used to restrict the search results
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAPIParameterByGUID
  
  public APIParameterElement getAPIParameterByGUID(String apiParameterGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the API parameter metadata element with the supplied unique identifier.
  
  Parameters:
  
  apiParameterGUID - unique identifier of the requested metadata element
  
  Returns:
  
  matching metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createPrimitiveSchemaType
  
  public String createPrimitiveSchemaType(PrimitiveSchemaTypeProperties schemaTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a primitive schema type such as a string, integer or character.
  
  Parameters:
  
  schemaTypeProperties - properties about the schema type to store
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createLiteralSchemaType
  
  public String createLiteralSchemaType(LiteralSchemaTypeProperties schemaTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema type that has a fixed value.
  
  Parameters:
  
  schemaTypeProperties - properties about the schema type to store
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createEnumSchemaType
  
  public String createEnumSchemaType(EnumSchemaTypeProperties schemaTypeProperties, String validValuesSetGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema type that has a fixed set of values that are described by a valid value set.
  
  Parameters:
  
  schemaTypeProperties - properties about the schema type to store
  
  validValuesSetGUID - unique identifier of the valid values set to used
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getValidValueSetByName
  
  public List<ValidValueSetElement> getValidValueSetByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of valid value set metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findValidValueSet
  
  public List<ValidValueSetElement> findValidValueSet(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of valid value set metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createStructSchemaType
  
  public String createStructSchemaType(StructSchemaTypeProperties schemaTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema type.
  
  Parameters:
  
  schemaTypeProperties - properties about the schema type to store
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createSchemaTypeChoice
  
  public String createSchemaTypeChoice(SchemaTypeChoiceProperties schemaTypeProperties, List<String> schemaTypeOptionGUIDs) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a list of possible schema types that can be used for the attached API parameter.
  
  Parameters:
  
  schemaTypeProperties - properties about the schema type to store
  
  schemaTypeOptionGUIDs - list of unique identifiers for schema types to link to
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createMapSchemaType
  
  public String createMapSchemaType(MapSchemaTypeProperties schemaTypeProperties, String mapFromSchemaTypeGUID, String mapToSchemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema type.
  
  Parameters:
  
  schemaTypeProperties - properties about the schema type to store
  
  mapFromSchemaTypeGUID - unique identifier of the domain of the map
  
  mapToSchemaTypeGUID - unique identifier of the range of the map
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createSchemaTypeFromTemplate
  
  public String createSchemaTypeFromTemplate(String templateGUID, TemplateProperties templateProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a schema type using an existing metadata element as a template.
  
  Parameters:
  
  templateGUID - unique identifier of the metadata element to copy
  
  templateProperties - properties that override the template
  
  Returns:
  
  unique identifier of the new schema type
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateSchemaType
  
  public void updateSchemaType(String schemaTypeGUID, boolean isMergeUpdate, SchemaTypeProperties schemaTypeProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a schema type. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  schemaTypeGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  schemaTypeProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeSchemaType
  
  public void removeSchemaType(String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a schema type.
  
  Parameters:
  
  schemaTypeGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupSchemaElementRelationship
  
  public void setupSchemaElementRelationship(String endOneGUID, String endTwoGUID, String relationshipTypeName, RelationshipProperties properties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a relationship between two schema elements. The name of the desired relationship, and any properties (including effectivity dates) are passed on the API.
  
  Parameters:
  
  endOneGUID - unique identifier of the schema element at end one of the relationship
  
  endTwoGUID - unique identifier of the schema element at end two of the relationship
  
  relationshipTypeName - type of the relationship to create
  
  properties - relationship properties
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearSchemaElementRelationship
  
  public void clearSchemaElementRelationship(String endOneGUID, String endTwoGUID, String relationshipTypeName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a relationship between two schema elements. The name of the desired relationship is passed on the API.
  
  Parameters:
  
  endOneGUID - unique identifier of the schema element at end one of the relationship
  
  endTwoGUID - unique identifier of the schema element at end two of the relationship
  
  relationshipTypeName - type of the relationship to delete
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findSchemaType
  
  public List<SchemaTypeElement> findSchemaType(String searchString, String typeName, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of schema type metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  typeName - optional type name for the schema type - used to restrict the search results
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaTypeForElement
  
  public SchemaTypeElement getSchemaTypeForElement(String parentElementGUID, String parentElementTypeName) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return the schema type associated with a specific open metadata element (data asset, process or port).
  
  Parameters:
  
  parentElementGUID - unique identifier of the open metadata element that this schema type is connected to
  
  parentElementTypeName - unique type name of the open metadata element that this schema type is connected to
  
  Returns:
  
  metadata element describing the schema type associated with the requested parent element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaTypeByName
  
  public List<SchemaTypeElement> getSchemaTypeByName(String name, String typeName, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of schema type metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  typeName - optional type name for the schema type - used to restrict the search results
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaTypeByGUID
  
  public SchemaTypeElement getSchemaTypeByGUID(String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the schema type metadata element with the supplied unique identifier.
  
  Parameters:
  
  schemaTypeGUID - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getSchemaTypeParent
  
  public ElementHeader getSchemaTypeParent(String schemaTypeGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the header of the metadata element connected to a schema type.
  
  Parameters:
  
  schemaTypeGUID - unique identifier of the requested metadata element
  
  Returns:
  
  header for parent element (data asset, process, port)
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- createValidValue
  
  public String createValidValue(ValidValueProperties validValueProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a new metadata element to represent a valid value.
  
  Parameters:
  
  validValueProperties - properties about the valid value to store
  
  Returns:
  
  unique identifier of the new valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- updateValidValue
  
  public void updateValidValue(String validValueGUID, boolean isMergeUpdate, ValidValueProperties validValueProperties) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Update the metadata element representing a valid value. It is possible to use the subtype property classes or set up specialized properties in extended properties.
  
  Parameters:
  
  validValueGUID - unique identifier of the metadata element to update
  
  isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
  
  validValueProperties - new properties for the metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupValidValueMember
  
  public void setupValidValueMember(String validValueSetGUID, ValidValueMembershipProperties properties, String validValueMemberGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a membership relationship between a validValue and a validValueSet that it belongs to.
  
  Parameters:
  
  validValueSetGUID - unique identifier of the valid value set
  
  properties - describes the properties of the membership
  
  validValueMemberGUID - unique identifier of the member
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearValidValueMember
  
  public void clearValidValueMember(String validValueSetGUID, String validValueMemberGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a membership relationship between a validValue and a validValueSet that it belongs to.
  
  Parameters:
  
  validValueSetGUID - unique identifier of the valid value set
  
  validValueMemberGUID - unique identifier of the member
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupValidValues
  
  public void setupValidValues(String elementGUID, ValidValueAssignmentProperties properties, String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a valid value assignment relationship between an element and a valid value (typically, a valid value set) to show that the valid value defines the values that can be stored in the data item that the element represents.
  
  Parameters:
  
  elementGUID - unique identifier of the element
  
  properties - describes the permissions that the role has in the validValue
  
  validValueGUID - unique identifier of the valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearValidValues
  
  public void clearValidValues(String elementGUID, String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a valid value assignment relationship between an element and a valid value.
  
  Parameters:
  
  elementGUID - unique identifier of the element
  
  validValueGUID - unique identifier of the valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- setupReferenceValueTag
  
  public void setupReferenceValueTag(String elementGUID, ReferenceValueAssignmentProperties properties, String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Create a reference value assignment relationship between an element and a valid value to show that the valid value is a semiformal tag/classification.
  
  Parameters:
  
  elementGUID - unique identifier of the element
  
  properties - describes the quality of the assignment
  
  validValueGUID - unique identifier of the valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- clearReferenceValueTag
  
  public void clearReferenceValueTag(String elementGUID, String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove a reference value assignment relationship between an element and a valid value.
  
  Parameters:
  
  elementGUID - unique identifier of the element
  
  validValueGUID - unique identifier of the valid value
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- removeValidValue
  
  public void removeValidValue(String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Remove the metadata element representing a valid value.
  
  Parameters:
  
  validValueGUID - unique identifier of the metadata element to remove
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- findValidValues
  
  public List<ValidValueElement> findValidValues(String searchString, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of metadata elements that contain the search string. The search string is treated as a regular expression.
  
  Parameters:
  
  searchString - string to find in the properties
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getValidValuesByName
  
  public List<ValidValueElement> getValidValuesByName(String name, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of metadata elements with a matching qualified or display name. There are no wildcards supported on this request.
  
  Parameters:
  
  name - name to search for
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getAllValidValues
  
  public List<ValidValueElement> getAllValidValues(int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the list of valid values.
  
  Parameters:
  
  startFrom - paging start point
  
  pageSize - maximum results that can be returned
  
  Returns:
  
  list of matching metadata elements
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)
- getValidValueSetMembers
  
  public List<ValidValueElement> getValidValueSetMembers(String validValueSetGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Page through the members of a valid value set.
  
  Parameters:
  
  validValueSetGUID - unique identifier of the valid value set
  
  startFrom - paging starting point
  
  pageSize - maximum number of return values.
  
  Returns:
  
  list of valid value beans
  
  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.
- getSetsForValidValue
  
  public List<ValidValueElement> getSetsForValidValue(String validValueGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Page through the list of valid value sets that a valid value definition/set belongs to.
  
  Parameters:
  
  validValueGUID - unique identifier of valid value to query
  
  startFrom - paging starting point
  
  pageSize - maximum number of return values.
  
  Returns:
  
  list of valid value beans
  
  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.
- getValidValuesForConsumer
  
  public ValidValueElement getValidValuesForConsumer(String elementGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the valid value set linked to an element as its set of valid values.
  
  Parameters:
  
  elementGUID - unique identifier for the element using the valid value set
  
  Returns:
  
  list of matching actor profiles (hopefully only one)
  
  Throws:
  
  InvalidParameterException - guid is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getConsumersOfValidValue
  
  public List<RelatedElement> getConsumersOfValidValue(String validValueGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the consumers linked to a validValue.
  
  Parameters:
  
  validValueGUID - unique identifier for the validValue
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of matching actor profiles (hopefully only one)
  
  Throws:
  
  InvalidParameterException - guid is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getReferenceValues
  
  public List<ValidValueElement> getReferenceValues(String elementGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the valid values linked as reference value tags to an element.
  
  Parameters:
  
  elementGUID - unique identifier for the element
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of valid values
  
  Throws:
  
  InvalidParameterException - guid is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getAssigneesOfReferenceValue
  
  public List<RelatedElement> getAssigneesOfReferenceValue(String validValueGUID, int startFrom, int pageSize) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Return information about the person roles linked to a validValue.
  
  Parameters:
  
  validValueGUID - unique identifier for the validValue
  
  startFrom - index of the list to start from (0 for start)
  
  pageSize - maximum number of elements to return.
  
  Returns:
  
  list of matching actor profiles (hopefully only one)
  
  Throws:
  
  InvalidParameterException - guid is null
  
  PropertyServerException - problem accessing property server
  
  UserNotAuthorizedException - security access problem
- getValidValueByGUID
  
  public ValidValueElement getValidValueByGUID(String validValueGUID) throws InvalidParameterException, UserNotAuthorizedException, PropertyServerException
  
  Retrieve the metadata element with the supplied unique identifier.
  
  Parameters:
  
  validValueGUID - unique identifier of the requested metadata element
  
  Returns:
  
  requested metadata element
  
  Throws:
  
  InvalidParameterException - one of the parameters is invalid
  
  UserNotAuthorizedException - the user is not authorized to issue this request
  
  PropertyServerException - there is a problem reported in the open metadata server(s)

Class APIIntegratorContext

Field Summary

Fields inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.frameworks.integration.context.IntegrationContext

Methods inherited from class java.lang.Object

Constructor Details

APIIntegratorContext

Method Details

getAPIManagerName

setAPIManagerIsHome

registerListener

createEndpoint

createEndpointFromTemplate

updateEndpoint

removeEndpoint

findEndpoints

getEndpointsByName

getEndpointByGUID

createAPI

createAPIFromTemplate

updateAPI

publishAPI

withdrawAPI

removeAPI

findAPIs

getAPIsByName

getMyAPIs

getAPIByGUID

createAPIOperation

createAPIOperationFromTemplate

updateAPIOperation

removeAPIOperation

findAPIOperations

getOperationsForAPI

getAPIOperationsByName

getAPIOperationByGUID

createAPIParameterList

createAPIParameterListFromTemplate

updateAPIParameterList

removeAPIParameterList

findAPIParameterLists

getParameterListsForAPIOperation

getAPIParameterListsByName

getAPIParameterListByGUID

createAPIParameter

createAPIParameterFromTemplate

setupSchemaType

clearSchemaTypes

updateAPIParameter

removeAPIParameter

findAPIParameters

getNestedAPIParameters

getAPIParametersByName

getAPIParameterByGUID

createPrimitiveSchemaType

createLiteralSchemaType

createEnumSchemaType

getValidValueSetByName

findValidValueSet

createStructSchemaType

createSchemaTypeChoice

createMapSchemaType

createSchemaTypeFromTemplate

updateSchemaType

removeSchemaType

setupSchemaElementRelationship

clearSchemaElementRelationship

findSchemaType

getSchemaTypeForElement

getSchemaTypeByName

getSchemaTypeByGUID

getSchemaTypeParent

createValidValue

updateValidValue

setupValidValueMember

clearValidValueMember

setupValidValues

clearValidValues