Package org.odpi.openmetadata.accessservices.assetowner.rest

package org.odpi.openmetadata.accessservices.assetowner.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
AnnotationListResponse	AnnotationListResponse is the response structure used on OMAS REST API calls that return a list of Annotations objects as a response.
AnnotationResponse	AnnotationResponse is the response structure used on the OMAS REST API calls that return a Annotation object as a response.
AssetElementResponse	AssetElementResponse is the response structure used on the OMAS REST API calls that return a AssetElement bean object as a response.
AssetElementsResponse	AssetElementsResponse returns a list of assets from the server.
AssetOwnerOMASAPIRequestBody	AssetOwnerOMASAPIRequestBody provides a common header for Asset Owner OMAS request bodies for its REST API.
AssetOwnerOMASAPIResponse	AssetOwnerOMASAPIResponse provides a common header for Asset Owner OMAS managed rest to its REST API.
CalculatedValueClassificationRequestBody	CalculatedValueClassificationRequestBody is used to identify the schema elements that are calculated (derived) rather than stored.
CertificateIdRequestBody	CertificateIdRequestBody provides a structure for the unique certificate identifier.
CertificationListResponse	CertificationTypeListResponse is the response structure used on the OMAS REST API calls that return a list of certifications as a response.
CertificationTypeListResponse	CertificationTypeListResponse is the response structure used on the OMAS REST API calls that return a list of certification types as a response.
CertificationTypeRequestBody	CertificationTypeRequestBody provides a structure used when creating certification types.
CertificationTypeResponse	CertificationTypeResponse is the response structure used on the OMAS REST API calls that returns a certification type object as a response.
ClassificationRequestBody	ClassificationRequestBody describes the request body used when attaching classification to elements.
CombinedSchemaRequestBody	CombinedSchemaRequestBody carries the parameters for created a new schema to attach to an asset.
ConnectionRequestBody	ConnectionRequestBody carries the parameters for created a new asset.
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.
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.
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.
ElementStubListResponse	ElementStubListResponse is the response structure used on the OMAS REST API calls that return a list of element identifiers as a response.
EmbeddedConnectionRequestBody	The EmbeddedConnection is used within a VirtualConnection to link to the embedded connections.
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.
ExternalReferenceIdRequestBody	ExternalReferenceIdRequestBody provides a structure for the unique external reference identifier.
ExternalReferenceListResponse	ExternalReferenceListResponse is the response structure used on the OMAS REST API calls that return a list of external references as a response.
ExternalReferenceRequestBody	ExternalReferenceRequestBody provides a structure for a new ExternalReference.
ExternalReferenceResponse	ExternalReferenceResponse is the response structure used on the OMAS REST API calls that returns a external reference object as a response.
ExternalSourceRequestBody	ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
FileSystemResponse	FileSystemResponse is the response structure used on the OMAS REST API calls that return the properties for a file system.
FolderResponse	FolderResponse is the response structure used on the OMAS REST API calls that return the properties for a folder.
LicenseIdRequestBody	LicenseIdRequestBody provides a structure for the unique certificate identifier.
LicenseListResponse	LicenseListResponse is the response structure used on the OMAS REST API calls that return a list of licenses as a response.
LicenseTypeListResponse	LicenseTypeListResponse is the response structure used on the OMAS REST API calls that return a list of license types as a response.
LicenseTypeRequestBody	LicenseTypeRequestBody provides a structure used when creating license types.
LicenseTypeResponse	LicenseTypeResponse is the response structure used on the OMAS REST API calls that returns a license type object as a response.
NewCSVFileAssetRequestBody	NewCSVFileAssetRequestBody carries the parameters for creating a new CSV file asset.
NewFileAssetRequestBody	NewFileAssetRequestBody carries the parameters for creating a new file asset.
NewFileSystemRequestBody	NewFileSystemProperties describes the root node of a file system.
OriginRequestBody	OriginRequestBody provides a structure for passing information about an asset's origin as a request body over a REST API.
OwnerRequestBody	OwnerRequestBody provides a structure for passing information about an asset owner as a request body over a REST API.
PagedResponse	PagedResponse is used for responses that can contain paged responses
PathNameRequestBody	PathNameRequestBody carries the parameters for creating a new FolderProperties asset.
ReferenceableRequestBody	ReferenceableRequestBody provides a structure for passing a referenceables' properties as a request body over a REST API.
RelatedElementListResponse	RelatedElementListResponse is a response object for passing back a list of relatedElement objects.
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.
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.
SecurityTagsRequestBody	SecurityTagsRequestBody provides a structure for passing information about the security tags that should be attached to an asset or one of its fields.
StatusRequestBody	StatusRequestBody provides a structure for passing the annotation status of an Annotation.
SurveyReportListResponse	SurveyReportListResponse is the response structure used on OMAS REST API calls that return a list of SurveyReport properties objects as a response.
TemplateClassificationRequestBody	TemplateClassificationRequestBody carries the parameters for classifying an element as suitable to use for a template.
TemplateRequestBody	TemplateRequestBody describes the request body used to create/update elements from templates.
UpdateRequestBody	UpdateRequestBody carries the correlation properties and effective time for a create, update or delete request.
ValidValueResponse	ValidValueResponse is a response object for passing back a single valid value object.
ValidValuesRequestBody	ValidValuesRequestBody carries the parameters for created a new valid values element.
ValidValuesResponse	ValidValuesResponse is a response object for passing back a list of valid value objects.