Package org.odpi.openmetadata.accessservices.datamanager.rest


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