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
ArchiveRequestBody	ArchiveRequestBody describes the request body used to create/update connection properties.
AssetElementsResponse	DataAssetElementsResponse is a response object for passing back a a list of assets or an exception if the request failed.
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.
ClassificationRequestBody	ClassificationRequestBody describes the request body used when classifying/reclassifying elements.
CommentElementResponse	CommentElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
CommentElementsResponse	CommentElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
CommentTypeListResponse	CommentTypeListResponse is a response object for passing back a list of enum values or an exception if the request failed.
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.
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 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 list of element headers or an exception if the request failed.
ElementStubsResponse	ElementStubsResponse is a response object for passing back a list of element stubs 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.
FindByPropertiesRequestBody	FindByPropertiesRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve an element by name.
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.
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 list of glossaries or an exception if the request failed.
GlossaryNameRequestBody	GlossaryNameRequestBody is the request body structure used on Glossary REST API calls that passes a name that is used to retrieve an element by name.
GlossarySearchStringRequestBody	GlossarySearchStringRequestBody is the request body structure used on GlossaryCategory/Term REST API calls that passes a regular expression to use as a search string and the scope of the results can be optionally restricted by glossary.
GlossaryTemplateRequestBody	GlossaryTemplateRequestBody describes the request body used to create a new glossary term from a template.
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.
GlossaryTermRelationshipRequestBody	GlossaryTermRelationshipRequestBody is the request body structure used on Glossary REST API calls that request the retrieval of glossary term relationships.
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.
GovernanceDefinitionsResponse	GovernanceDefinitionsResponse is the response structure used on the OMAS REST API calls that return a list of governance definitions as a response.
HistoryRequestBody	HistoryRequestBody describes the start and stop time of the historical query.
InformalTagResponse	InformalTagResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a Tag object as a response.
InformalTagsResponse	InformalTagsResponse returns a list of tags from the server.
InformalTagUpdateRequestBody	InformalTagProperties stores information about a tag connected to an asset.
LikeElementResponse	LikeElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
LikeElementsResponse	LikeElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
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.
NoteElementResponse	NoteElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
NoteElementsResponse	NoteElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
NoteLogElementResponse	NoteLogElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
NoteLogElementsResponse	NoteLogElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
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.
RatingElementResponse	RatingElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
RatingElementsResponse	RatingElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
ReferenceableRequestBody	ReferenceableRequestBody describes the request body used to create/update properties in referenceables.
ReferenceableUpdateRequestBody	ReferenceableUpdateRequestBody carries the correlation properties, readVersionIdentifier and effective time for a create (with parent), update or delete requests.
RelatedElementsResponse	RelatedElementElementsResponse is a response object for passing back a list of relationships or an exception if the request failed.
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 an element.
SchemaTypeElementsResponse	SchemaTypeElementsResponse is a response object for passing back a list of elements 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.
TemplateRequestBody	TemplateRequestBody describes the request body used to create/update elements from templates.
TermAssignmentStatusListResponse	TermAssignmentStatusListResponse is a response object for passing back a list of enum values or an exception if the request failed.
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.