Package org.odpi.openmetadata.commonservices.ffdc.rest

package org.odpi.openmetadata.commonservices.ffdc.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.

Related Packages

Package	Description
org.odpi.openmetadata.commonservices.ffdc	The FFDC Services provide common exceptions and error handling for service running in OMAG Servers.
org.odpi.openmetadata.commonservices.ffdc.exceptions
org.odpi.openmetadata.commonservices.ffdc.properties	Beans used in providing FFDC context and support to open metadata and governance.

Class	Description
ActionRequestBody	ActionRequestBody provides a structure for passing action details over a REST API.
ActivityStatusFilterRequestBody	ActivityStatusFilterRequestBody provides a structure for passing the status.
ActivityStatusRequestBody	ActivityStatusRequestBody provides a structure for passing the status.
ActivityStatusSearchString	A request body that allows the status of an activity to be included in the search criteria.
AnnotationResponse	AnnotationResponse is the response structure used on the OMAS REST API calls that return a Annotation object as a response.
AnnotationsResponse	AnnotationsResponse is the response structure used on OMAS REST API calls that return a list of Annotations objects as a response.
AnnotationStatusRequestBody	AnnotationStatusRequestBody provides a structure for passing the annotation status of an Annotation.
ArchiveRequestBody	ArchiveRequestBody carries the parameters for marking an asset as archived (or deleted).
AssetGraphResponse	AssetGraphResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns an AssetGraph object as a response.
AssetLineageGraphRequestBody	AssetLineageGraphRequestBody provides the request body payload for an asset lineage graph.
AssetLineageGraphResponse	AssetLineageGraphResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns an AssetLineageGraph object as a response.
AssetRelationshipsResponse	AssetRelationshipsResponse is a response object for passing back a list of relationships between assets or an exception if the request failed.
AssetSearchMatchesListResponse	AssetSearchMatchesListResponse returns the list of results from an asset domain search.
BooleanRequestBody	BooleanRequestBody is the request body structure used on OMAG REST API calls that passed a boolean flag.
BooleanResponse	BooleanResponse is the response structure used on OMAG REST API calls that return a boolean response.
CertificationElementsResponse	CertificationElementsResponse is the response structure used on the OMAS REST API calls that return a list of related certification element summaries as a response.
ConnectorReportResponse	ConnectorReportResponse is the response structure used on REST API calls that return a ConnectorType object as a response.
CountResponse	CountResponse defines the response structure for the OMAS REST API calls that returns a number as a response.
DeleteClassificationRequestBody	DeleteElementRequestBody carries the options for a delete element.
DeleteElementRequestBody	DeleteElementRequestBody carries the options for a delete element.
DeleteGovernanceConfigRequestBody	DeleteGovernanceConfigRequestBody provides a structure for passing the qualified name of an object to be deleted.
DeleteRelationshipRequestBody	DeleteElementRequestBody carries the options for a delete element.
DeleteRequestBody	DeleteRequestBody carries the options for a delete element.
EffectiveTimeRequestBody	EffectiveTimeQueryRequestBody carries the date/time for a query.
ElementHeaderResponse	ElementHeaderResponse is the response structure used on the OMAS REST API calls that return the header for a element.
ElementHeadersResponse	ElementHeadersResponse is a response object for passing back a list of element headers or an exception if the request failed.
ExternalReferenceRequestBody	ExternalReferenceRequestBody provides a structure for a new ExternalReference.
ExternalReferenceResponse	ExternalReferenceResponse is the response structure used on the OMAS REST API calls that returns a external reference object as a response.
ExternalReferencesResponse	ExternalReferencesResponse is the response structure used on the OMAS REST API calls that return a list of external references as a response.
ExternalSourceRequestBody	ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
FFDCResponse	FFDCResponse is the top-level class for a response object used to return results on REST APIs.
FFDCResponseBase	FFDCResponseBase provides the base class for REST API responses.
FFDCRESTClient	RESTClient is responsible for issuing calls to the OMAS REST APIs.
FFDCRESTClientBase	RESTClient is responsible for issuing calls to the OMAS REST APIs.
FilterRequestBody	FilterRequestBody is the request body structure used on OMAG REST API calls that passed a string that is used to filter responses.
GetRequestBody	GetRequestBody describes the query options for a request that returns a single element.
GUIDListResponse	GUIDListResponse is the response structure used on the OMAS REST API calls that return a list of unique identifiers (guids) as a response.
GUIDResponse	GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.
InformationSupplyChainResponse	The response structure used on a REST API calls that returns a InformationSupplyChainElement element object as a response.
InformationSupplyChainsResponse	The response structure used on REST API calls that returns a list of InformationSupplyChainElement objects as a response.
IntegrationReportResponse	IntegrationReportResponse is the response structure used on REST API calls that returns an ConnectorActivityReport object as a response.
IntegrationReportsResponse	IntegrationReportsResponse is the response structure used on REST API calls that returns a list of ConnectorActivityReport objects as a response.
LogRecordRequestBody	LogRecordRequestBody provides a structure for passing a log record as a request body over a REST API.
MetadataElementSummariesResponse	MetadataElementSummariesResponse is the response structure used on the OMAS REST API calls that return a list of element identifiers as a response.
MetadataElementSummaryResponse	MetadataElementSummaryResponse is a response object for passing back a single element or an exception if the request failed.
MetadataRelationshipSummariesResponse	MetadataRelationshipSummariesResponse is the response structure used on the OMAS REST API calls that return a list of relationships identifiers as a response.
MetadataSourceRequestBody	MetadataSourceRequestBody carries the parameters for marking an element, classification or relationship as external and for working with lineage/duplicate processing and effective time.
NameListResponse	NameListResponse is the response structure used on the OMAS REST API calls that return a list of names as a response.
NameRequestBody	NameRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve an element by name.
NewClassificationRequestBody	NewClassificationRequestBody describes the request body used when attaching classification to elements.
NewCSVFileAssetRequestBody	NewCSVFileAssetRequestBody carries the parameters for creating a new CSV file asset.
NewElementRequestBody	NewElementRequestBody provides a structure used when creating new elements.
NewFeedbackRequestBody	NewElementRequestBody provides a structure used when creating new elements.
NewFileAssetRequestBody	NewFileAssetRequestBody carries the parameters for creating a new file asset.
NewFileSystemRequestBody	NewFileSystemProperties describes the root node of a file system.
NewRelationshipRequestBody	NewRelationshipRequestBody describes the request body used when linking elements together.
NullRequestBody	NullRequestBody provides a empty request body object for POST requests that do not need to send additional parameters beyond the path variables.
OCFConnectionResponse	OCFConnectionResponse is the response structure used on REST API calls that return a Connection object as a response.
OCFConnectorTypeResponse	OCFConnectorTypeResponse is the response structure used on REST API calls that return a ConnectorType object as a response.
OpenMetadataRootElementResponse	OpenMetadataRootElementResponse is the response structure used on the OMVS REST API calls that return an open metadata bean element as a response.
OpenMetadataRootElementsResponse	OpenMetadataRootElementsResponse is the response structure used on the OMVS REST API calls that returns a list of open metadata bean elements.
PropertiesResponse	PropertiesResponse is the response structure used on REST API calls that return a property map object as a response.
RegisteredOMAGService	RegisteredOMAGServicesResponse provides an object for returning information about a service that is registered with an OMAG Server Platform.
RegisteredOMAGServiceResponse	Provides a response object for returning information about a service that is registered in an OMAG Server Platform.
RegisteredOMAGServicesResponse	RegisteredOMAGServicesResponse provides a response object for returning information about a list of services that are registered in an OMAG Server Platform.
RelatedMetadataElementSummariesResponse	RelatedMetadataElementSummariesResponse is the response structure used on the OMAS REST API calls that return a list of element summaries as a response.
RelationshipElementResponse	RelationshipElementResponse is the response structure used on the OMAS REST API calls that return the properties for a relationship.
RelationshipElementsResponse	RelationshipElementsResponse is a response object for passing back a list of relationships or an exception if the request failed.
ResultsRequestBody	ResultsRequestBody carries the date/time for a query along with other common search parameters.
SearchStringRequestBody	SearchStringRequestBody is the request body structure used on OMAG REST API calls that passes a regular expression to use as a search string.
SolutionBlueprintResponse	The response structure used on a REST API calls that returns a SolutionBlueprintElement element object as a response.
SolutionBlueprintsResponse	The response structure used on REST API calls that returns a list of SolutionBlueprintElement objects as a response.
SolutionComponentResponse	SolutionComponentResponse is the response structure used on a REST API calls that returns a SolutionComponentElement object as a response.
SolutionComponentsResponse	The response structure used on REST API calls that returns a list of GovernanceActionProcessStepElement objects as a response.
StringMapResponse	StringMapResponse is the response structure used on the OMAS REST API calls that return a map of names to description as a response.
StringRequestBody	StringRequestBody is the request body structure used on OMAG REST API calls that passed a string.
StringResponse	GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.
SurveyReportsResponse	SurveyReportsResponse is the response structure used on OMAS REST API calls that return a list of SurveyReport properties objects as a response.
TemplateRequestBody	TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.
UpdateClassificationRequestBody	NewClassificationRequestBody describes the request body used when updating classification properties.
UpdateElementRequestBody	UpdateElementRequestBody describes the properties to update an open metadata element.
UpdateRelationshipRequestBody	UpdateRelationshipRequestBody describes the request body used when updating relationship properties
UpdateWithTemplateRequestBody	UpdateElementRequestBody describes the properties to update an open metadata element.
VoidResponse	VoidResponse defines the response structure for the OMAS REST API calls that returns a void as a response.