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

package org.odpi.openmetadata.accessservices.assetmanager.rest

This package defines the beans used to build the REST request and response payloads. REST APIs can pass parameters in their URLs (called path variables) as well has having a RequestBody bean for additional, more complex, or optional parameters. Responses are returned in response beans. The response beans encode the return type of the method as well as any exceptions and associated messages.

Classes

Class	Description
ActivityTermClassificationRequestBody	ActivityTermClassificationRequestBody is used to classify a glossary that describes an activity.
AssetManagerIdentifiersRequestBody	AssetManagerIdentifiersRequestBody provides the identifiers for an asset manager.
AssetManagerOMASAPIResponse	AssetManagerOMASAPIResponse provides a common header for Asset Manager OMAS managed rest to its REST API.
CalculatedValueClassificationRequestBody	CalculatedValueClassificationRequestBody is used to identify the schema elements that are calculated (derived) rather than stored.
CanonicalVocabularyClassificationRequestBody	CanonicalVocabularyClassificationRequestBody is used to classify a glossary that has no term definitions with the same name.
ConnectionRequestBody	ConnectionRequestBody describes the request body used to create/update connection properties.
ConnectionResponse	ConnectionResponse is a response object for passing back a single connection object.
ConnectionsResponse	ConnectionsResponse is a response object for passing back a list of connection objects.
ConnectorTypeRequestBody	ConnectorTypeRequestBody describes the request body used to create/update connector type properties.
ConnectorTypeResponse	ConnectorReportResponse is a response object for passing back a single connector type object.
ConnectorTypesResponse	ConnectorTypesResponse is a response object for passing back a list of connector type objects.
ContextDefinitionClassificationRequestBody	ContextDefinitionClassificationRequestBody is used to classify a glossary term to say it described a context.
ControlFlowElementResponse	ControlFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
ControlFlowElementsResponse	ControlFlowElementsResponse is a response object for passing back a a list of control flow relationships or an exception if the request failed.
ControlFlowRequestBody	ControlFlowRequestBody describes the request body used when linking elements within processes.
ControlledGlossaryTermRequestBody	ControlledGlossaryTermRequestBody describes the request body used to create/update controlled glossary term properties.
DataAssetElementResponse	DataAssetElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
DataAssetElementsResponse	DataAssetElementsResponse is a response object for passing back a a list of assets or an exception if the request failed.
DataAssetRequestBody	DataAssetRequestBody describes the request body used to create/update asset properties.
DataFlowElementResponse	DataFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties for a relationship.
DataFlowElementsResponse	DataFlowElementsResponse is a response object for passing back a list of relationships or an exception if the request failed.
DataFlowRequestBody	DataFlowRequestBody describes the request body used when linking elements within processes.
EffectiveTimeQueryRequestBody	EffectiveTimeQueryRequestBody carries the date/time for a query.
ElementHeaderResponse	ElementHeaderResponse is the response structure used on the OMAS REST API calls that return the header for a element.
ElementHeadersResponse	ElementHeadersResponse is a response object for passing back a a list of element headers or an exception if the request failed.
EndpointRequestBody	EndpointRequestBody describes the request body used to create/update endpoint properties.
EndpointResponse	EndpointResponse is a response object for passing back a single endpoint object.
EndpointsResponse	EndpointsResponse is a response object for passing back a list of endpoint objects.
ExternalGlossaryElementLinkRequestBody	ExternalGlossaryElementLinkRequestBody describes the request body used to create/update links to external glossary elements.
ExternalGlossaryLinkElementsResponse	ExternalGlossaryLinkElementsResponse is a response object for passing back a a list of external glossary links or an exception if the request failed.
ExternalGlossaryLinkRequestBody	ExternalGlossaryLinkRequestBody describes the request body used to create/update links to external glossary elements.
ExternalReferenceElementResponse	ExternalReferenceElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
ExternalReferenceElementsResponse	ExternalReferenceElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
ExternalReferenceLinkElementResponse	ExternalReferenceElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
ExternalReferenceLinkElementsResponse	ExternalReferenceLinkElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
ExternalReferenceLinkRequestBody	ExternalGlossaryLinkRequestBody describes the request body used to create/update links to external glossary elements.
ExternalReferenceRequestBody	ExternalReferenceRequestBody describes the request body used to create/update external reference properties.
ForeignKeyRequestBody	ForeignKeyRequestBody describes the request body used when creating a foreign key relationship.
GlossaryCategoryElementResponse	GlossaryElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
GlossaryCategoryElementsResponse	GlossaryCategoryElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
GlossaryCategoryRequestBody	GlossaryCategoryRequestBody describes the request body used to create/update glossary category properties.
GlossaryElementResponse	GlossaryElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
GlossaryElementsResponse	GlossaryElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
GlossaryRequestBody	GlossaryRequestBody describes the request body used to create/update glossary properties.
GlossaryTermElementResponse	GlossaryTermElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
GlossaryTermElementsResponse	GlossaryTermElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
GlossaryTermRequestBody	GlossaryTermRequestBody describes the request body used to create/update glossary term properties.
GlossaryTermStatusRequestBody	GlossaryTermStatusRequestBody describes the request body used to update a glossary term's status.
GovernanceActionElementResponse	GovernanceActionElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceAction element object as a response.
GovernanceActionElementsResponse	GovernanceActionElementsResponse is the response structure used on REST API calls that returns a list of GovernanceActionElement objects as a response.
GovernanceActionProcessElementResponse	GovernanceActionProcessElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceActionProcess element object as a response.
GovernanceActionProcessElementsResponse	GovernanceActionProcessElementsResponse is the response structure used on REST API calls that returns a list of GovernanceActionProcessElement objects as a response.
GovernanceActionTypeElementResponse	GovernanceActionTypeElementResponse is the response structure used on the Governance Engine OMAS REST API calls that returns a GovernanceActionType element object as a response.
GovernanceActionTypeElementsResponse	GovernanceActionTypeElementsResponse is the response structure used on REST API calls that returns a list of GovernanceActionTypeElement objects as a response.
LineageMappingElementResponse	DataFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties for a relationship.
LineageMappingElementsResponse	LineageMappingElementsResponse is a response object for passing back a a list of lineage mapping relationships or an exception if the request failed.
NameRequestBody	NameRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve an element by name.
NextGovernanceActionTypeElementsResponse	NextGovernanceActionTypeElementsResponse is the response structure used on REST API calls that returns a list of NextGovernanceActionTypeElement objects as a response.
PortElementResponse	PortElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
PortElementsResponse	PortElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
PortRequestBody	PortRequestBody describes the request body used to create/update port properties.
PrimaryKeyClassificationRequestBody	PrimaryKeyClassificationRequestBody is used to classify a schema attribute as a primary key.
ProcessCallElementResponse	ProcessCallElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
ProcessCallElementsResponse	ProcessCallElementsResponse is a response object for passing back a a list of process call relationships or an exception if the request failed.
ProcessCallRequestBody	ProcessCallRequestBody describes the request body used when linking elements within processes.
ProcessElementResponse	ProcessElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
ProcessElementsResponse	ProcessElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
ProcessRequestBody	ProcessRequestBody describes the request body used to create/update process properties.
ProcessStatusRequestBody	ProcessStatusRequestBody describes the request body used to update a process's status.
RelationshipElementResponse	RelationshipElementResponse is the response structure used on the OMAS REST API calls that return the properties for a relationship.
RelationshipElementsResponse	RelationshipElementsResponse is a response object for passing back a list of relationships or an exception if the request failed.
RelationshipRequestBody	RelationshipRequestBody describes the request body used when linking elements together.
SchemaAttributeElementResponse	SchemaAttributeElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
SchemaAttributeElementsResponse	SchemaAttributeElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
SchemaAttributeRequestBody	SchemaAttributeRequestBody describes the request body used to create/update schema attribute properties.
SchemaTypeElementResponse	SchemaTypeElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
SchemaTypeElementsResponse	SchemaTypeElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
SchemaTypeRequestBody	SchemaTypeRequestBody describes the request body used to create/update schema type properties.
SearchStringRequestBody	SearchStringRequestBody is the request body structure used on OMAG REST API calls that passes a regular expression to use as a search string.
TaxonomyClassificationRequestBody	TaxonomyClassificationRequestBody is used to classify a glossary that has the terms organized in a taxonomy.
TemplateRequestBody	TemplateRequestBody describes the request body used to create/update elements from templates.
TermRelationshipRequestBody	TermRelationshipRequestBody describes the request body used when linking two terms together.
UpdateRequestBody	UpdateRequestBody carries the correlation properties and effective time for a create, update or delete request.