Package org.odpi.openmetadata.accessservices.datamanager.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 APIManagerRequestBody APIManagerRequestBody describes the basic properties of an API manager's software server capability.APIOperationRequestBody APIOperationRequestBody describes the properties of the API operation plus the optional identifiers for an owning software server capability.APIOperationResponse APIOperationResponse is a response object for passing back a single APIOperation element or an exception if the request failed.APIOperationsResponse APIOperationsResponse is a response object for passing back a a list of APIOperations or an exception if the request failed.APIParameterListRequestBody APIParameterListRequestBody describes the properties of the API parameter list plus the optional identifiers for an owning software server capability.APIParameterListResponse APIParameterListResponse is a response object for passing back a single APIParameterList element or an exception if the request failed.APIParameterListsResponse APIParameterListsResponse is a response object for passing back a a list of APIParameterLists or an exception if the request failed.APIParameterResponse APIParameterResponse is a response object for passing back a single APIParameter element or an exception if the request failed.APIParametersResponse APIParametersResponse is a response object for passing back a a list of APIParameters or an exception if the request failed.APIRequestBody APIRequestBody describes the properties of the API plus the optional identifiers for an owning software server capability.APIResponse APIResponse is a response object for passing back a single API element or an exception if the request failed.APIsResponse APIsResponse is a response object for passing back a a list of APIs or an exception if the request failed.ApplicationRequestBody ApplicationRequestBody describes the basic properties of an application's software server capability.ArchiveRequestBody ArchiveRequestBody carries the parameters for marking an asset as archived (or deleted).AssetConnectionRequestBody AssetConnectionRequestBody carries the parameters for creating a new relationship between an asset and a connection.ConnectionRequestBody ConnectionRequestBody carries the parameters for describing a connection.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 carries the parameters for describing a connector type.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.DatabaseColumnResponse DatabaseColumnResponse is a response object for passing back a single database column element or an exception if the request failed.DatabaseColumnsResponse DatabaseColumnsResponse is a response object for passing back a a list of database columns or an exception if the request failed.DatabaseManagerRequestBody DatabaseManagerRequestBody describes the basic properties of a database manager's software server capability.DatabaseResponse DatabaseResponse is a response object for passing back a single database element or an exception if the request failed.DatabaseSchemaResponse DatabaseSchemaResponse is a response object for passing back a single database schema element or an exception if the request failed.DatabaseSchemasResponse DatabaseSchemasResponse is a response object for passing back a a list of database schemas or an exception if the request failed.DatabasesResponse DatabasesResponse is a response object for passing back a a list of databases or an exception if the request failed.DatabaseTableResponse DatabaseTableResponse is a response object for passing back a single database table element or an exception if the request failed.DatabaseTablesResponse DatabaseTablesResponse is a response object for passing back a a list of database tables or an exception if the request failed.DatabaseViewResponse DatabaseViewResponse is a response object for passing back a single database view element or an exception if the request failed.DatabaseViewsResponse DatabaseViewsResponse is a response object for passing back a a list of database views or an exception if the request failed.DataContainerRequestBody DataContainerRequestBody describes the properties of the data container plus the optional identifiers for an owning software server capability.DataContainerResponse DataContainerResponse is a response object for passing back a single data container element or an exception if the request failed.DataContainersResponse DataContainersResponse is a response object for passing back a a list of data containers or an exception if the request failed.DataFieldRequestBody DataFieldRequestBody describes the properties of the data field plus the optional identifiers for an owning software server capability.DataFieldResponse DataFieldResponse is a response object for passing back a single data field element or an exception if the request failed.DataFieldsResponse DataFieldsResponse is a response object for passing back a a list of data fields or an exception if the request failed.DataFileRequestBody DataFileRequestBody carries the parameters for creating a new file asset.DataFileResponse DataFileResponse is the response structure used on the OMAS REST API calls that return the properties for a file.DataFilesResponse DataFilesResponse is a response object for passing back a a list of database views or an exception if the request failed.DataFolderRequestBody DataFileRequestBody carries the parameters for creating a new file asset.DataManagerOMASAPIRequestBody DataManagerOMASAPIRequestBody provides a common header for Data Manager OMAS request bodies for its REST API.DataManagerOMASAPIResponse DataManagerOMASAPIResponse provides a common header for Data Manager OMAS managed rest to its REST API.DataProcessingEngineRequestBody DataProcessingEngineRequestBody describes the basic properties of a data processing engine's software server capability.DerivedSchemaTypeQueryTargetRequestBody DerivedSchemaTypeQueryTargetRequestBody describes the properties of a query target plus the optional identifiers for an owning software server capability.ElementStubResponse ElementStubResponse is a response object for passing back the header of a Referenceable element or an exception if the request failed.EmbeddedConnectionRequestBody The EmbeddedConnectionRequestBody is used within a VirtualConnection to link to the embedded connections.EndpointRequestBody EndpointRequestBody carries the parameters for describing an endpoint.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.EnumSchemaTypeRequestBody EnumSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.EventBrokerRequestBody EventBrokerRequestBody describes the basic properties of a event broker's software server capability.EventTypeRequestBody EventTypeRequestBody describes the properties of the event type plus the optional identifiers for an owning software server capability.EventTypeResponse EventTypeResponse is a response object for passing back a single EventType element or an exception if the request failed.EventTypesResponse EventTypesResponse is a response object for passing back a a list of EventTypes or an exception if the request failed.ExternalReferenceLinkRequestBody ExternalReferenceRequestBody describes the properties of the external reference plus the optional identifiers for an owning element.ExternalReferenceRequestBody ExternalReferenceRequestBody describes the properties of the external reference plus the optional identifiers for an owning element.ExternalReferenceResponse ExternalReferenceResponse is a response object for passing back a single external reference element or an exception if the request failed.ExternalReferencesResponse ExternalReferencesResponse is a response object for passing back a a list of external references or an exception if the request failed.FileFolderResponse FileFolderResponse is the response structure used on the OMAS REST API calls that return the properties for a folder.FileFoldersResponse FileFoldersResponse is a response object for passing back a a list of database views or an exception if the request failed.FileManagerRequestBody FileManagerProperties describes the root node of a file system.FileSystemRequestBody FileSystemProperties describes the root node of a file system.FileSystemResponse FileSystemResponse is the response structure used on the OMAS REST API calls that return the properties for a file system.FormRequestBody FormRequestBody describes the properties of the form plus the optional identifiers for an owning software server capability.FormResponse FormResponse is a response object for passing back a single form element or an exception if the request failed.FormsResponse FormsResponse is a response object for passing back a a list of forms or an exception if the request failed.FormulaRequestBody FormulaRequestBody carries the parameters for creating a new CalculatedValue classification.LiteralSchemaTypeRequestBody LiteralSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.MapSchemaTypeRequestBody MapSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.MetadataSourceRequestBody MetadataSourceRequestBody carries the parameters for marking an asset or schema as external.PathNameRequestBody PathNameRequestBody carries the parameters for creating a new FileFolder asset.PrimitiveSchemaTypeRequestBody PrimitiveSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.QueriesResponse QueriesResponse is a response object for passing back a a list of queries or an exception if the request failed.QueryRequestBody QueryRequestBody describes the properties of the query plus the optional identifiers for an owning software server capability.QueryResponse QueryResponse is a response object for passing back a single query element or an exception if the request failed.ReportRequestBody ReportRequestBody describes the properties of the report plus the optional identifiers for an owning software server capability.ReportResponse ReportResponse is a response object for passing back a single report element or an exception if the request failed.ReportsResponse ReportsResponse is a response object for passing back a a list of reports or an exception if the request failed.SchemaAttributeRequestBody SchemaAttributeRequestBody describes the properties of the schema attribute plus the optional identifiers for an owning software server capability.SchemaAttributeResponse SchemaAttributeResponse is a response object for passing back a single schema attribute element or an exception if the request failed.SchemaAttributesResponse SchemaAttributesResponse is a response object for passing back a a list of schema attributes or an exception if the request failed.SchemaTypeChoiceRequestBody SchemaTypeChoiceRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability and the list of guids for the schema types that represent the choices.SchemaTypeRequestBody SchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.SchemaTypeResponse SchemaTypeResponse is a response object for passing back a single topic element or an exception if the request failed.SchemaTypesResponse SchemaTypesResponse is a response object for passing back a a list of schema types or an exception if the request failed.SoftwareCapabilityRequestBody SoftwareCapabilityRequestBody describes the basic properties of a software server capability.StructSchemaTypeRequestBody StructSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.TemplateRequestBody TemplateRequestBody carries the parameters for creating a new asset using a template.TopicRequestBody TopicRequestBody describes the properties of the topic plus the optional identifiers for an owning software server capability.TopicResponse TopicResponse is a response object for passing back a single topic element or an exception if the request failed.TopicsResponse TopicsResponse is a response object for passing back a a list of topics or an exception if the request failed.ValidValueSetsResponse ValidValueSetsResponse is a response object for passing back a a list of valid value sets or an exception if the request failed.