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