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.
-
Class Summary 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.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 ConnectorTypeResponse 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.DiscoveryAnalysisReportListResponse DiscoveryAnalysisReportListResponse is the response structure used on OMAS REST API calls that return a list of DiscoveryAnalysisReport properties objects 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.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.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 responsesPathNameRequestBody 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.SchemaAttributeRequestBody SchemaAttributeRequestBody carries the common parameters for creating or updating a schema attribute.SchemaAttributesRequestBody SchemaAttributesRequestBody carries the common parameters for creating a list of schema attributes.SchemaTypeRequestBody Deprecated. 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.TemplateClassificationRequestBody TemplateClassificationRequestBody carries the parameters for classifying an asset as suitable to use for a template.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.