Package org.odpi.openmetadata.accessservices.itinfrastructure.rest


package org.odpi.openmetadata.accessservices.itinfrastructure.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
    AssetConnectionRequestBody carries the parameters for creating a new relationship between an asset and a connection.
    AssetExtensionsRequestBody provides the request body payload for relationships between assets.
    AssetListResponse is a response object for passing back a a list of hosts or an exception if the request failed.
    AssetRelationshipListResponse is a response object for passing back a list of relationships between assets or an exception if the request failed.
    AssetRequestBody describes the properties of the asset for creation and update.
    AssetResponse is a response object for passing back a single asset element or an exception if the request failed.
    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.
    ContactMethodRequestBody provides the request body payload for working on ContactMethod entities.
    ControlFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
    ControlFlowElementsResponse is a response object for passing back a a list of control flow relationships or an exception if the request failed.
    ControlFlowRequestBody describes the request body used when linking elements within processes.
    DataFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
    DataFlowElementsResponse is a response object for passing back a a list of data flow relationships or an exception if the request failed.
    DataFlowRequestBody describes the request body used when linking elements within processes.
    DeploymentRequestBody provides the request body payload for working with the relationships between software server platforms and hosts.
    MetadataSourceRequestBody carries the parameters for marking an element as external with the effective time set up.
    EffectiveTimeRequestBody carries the date/time for a query.
    ElementStatusRequestBody describes the status of an asset.
    ElementStubResponse is a response object for passing back the header of a Referenceable element or an exception if the request failed.
    ElementStubListResponse is the response structure used on the OMAS REST API calls that return a list of element identifiers as a response.
    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.
    HostListResponse is a response object for passing back a a list of hosts or an exception if the request failed.
    HostRequestBody describes the properties of the software server for creation and update.
    HostResponse is a response object for passing back a single host element or an exception if the request failed.
    DataManagerOMASAPIRequestBody provides a common header for Data Manager OMAS request bodies for its REST API.
    ITInfrastructureOMASAPIResponse provides a common header for IT Infrastructure OMAS managed rest to its REST API.
    ITProfileListResponse is the response structure used on the OMAS REST API calls that return a a list of profile elements.
    ITProfileRequestBody provides the request body payload for working on ActorProfile entities.
    ITProfileResponse is the response structure used on the OMAS REST API calls that return a ActorProfileElement object as a response.
    LineageMappingElementResponse is the response structure used on the OMAS REST API calls that return the properties for a relationship.
    LineageMappingElementsResponse is a response object for passing back a a list of lineage mapping relationships or an exception if the request failed.
    LineageMappingRequestBody describes the request body used when adding a lineage mapping.
    MetadataSourceRequestBody carries the parameters for marking an element as external.
    PortElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
    PortElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
    PortRequestBody describes the request body used to create/update port properties.
    ProcessCallElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
    ProcessCallElementsResponse is a response object for passing back a a list of process call relationships or an exception if the request failed.
    ProcessCallRequestBody describes the request body used when linking elements within processes.
    ProcessContainmentTypeRequestBody is the request body structure used on OMAG REST API calls that passes a ProcessContainmentType enum.
    ProcessElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
    ProcessElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
    ProcessRequestBody describes the request body used to create/update process properties.
    ProcessStatusRequestBody describes the request body used to update a process's status.
    ProfileIdentityRequestBody provides the request body payload for working with ProfileIdentity relationships.
    RelatedAssetListResponse is a response object for passing back a list of related assets with te properties from the relationship or an exception if the request failed.
    ServerAssetUseListResponse returns a list of serverAssetUse relationships from the server.
    ServerAssetUseRequestBody provides the request body payload for working with the relationships between software server capabilities and assets.
    ServerAssetUseResponse is a response object for passing back a single relationship between a software server capability and an asset (or an exception if the request failed).
    SoftwareCapabilityListResponse is a response object for passing back a a list of software server capabilities or an exception if the request failed.
    SoftwareCapabilityRequestBody describes the properties of the software server capability for creation and update.
    SoftwareCapabilityResponse is a response object for passing back a single software server capability element or an exception if the request failed.
    SoftwareServerListResponse is a response object for passing back a a list of software servers or an exception if the request failed.
    SoftwareServerPlatformListResponse is a response object for passing back a a list of software server platforms or an exception if the request failed.
    SoftwareServerPlatformRequestBody describes the properties of the software server platform for creation and update.
    SoftwareServerPlatformResponse is a response object for passing back a single software server platform element or an exception if the request failed.
    SoftwareServerRequestBody describes the properties of the software server for creation and update.
    SoftwareServerResponse is a response object for passing back a single software server element or an exception if the request failed.
    SupportedCapabilityListResponse returns a list of SoftwareServerSupportedCapability relationships from the server.
    SupportedCapabilityRequestBody provides the request body payload for working with the relationships between software servers and software server capabilities.
    TemplateRequestBody carries the parameters for creating a new asset using a template.
    UserIdentityListResponse is the response structure used on the OMAS REST API calls that return a a list of user identity elements.
    UserIdentityRequestBody provides the request body payload for working on UserIdentity entities and their link to profiles.
    UserIdentityResponse is the response structure used on the OMAS REST API calls that return a UserIdentityElement object as a response.
    UseTypeRequestBody for passing the use type and effective time.