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.
-
ClassDescriptionActionRequestBody provides a structure for passing action details over a REST API.ActivityStatusFilterRequestBody provides a structure for passing the status.ActivityStatusRequestBody provides a structure for passing the status.A request body that allows the status of an activity to be included in the search criteria.AssetLineageGraphRequestBody provides the request body payload for an asset lineage graph.BooleanRequestBody is the request body structure used on OMAG REST API calls that passed a boolean flag.BooleanResponse is the response structure used on OMAG REST API calls that return a boolean response.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 is the response structure used on REST API calls that return a ConnectorType object as a response.DeleteElementRequestBody carries the options for a delete element.DeleteElementRequestBody carries the options for a delete element.DeleteRelationshipRequestBody carries the options for a delete element.DeleteRequestBody carries the options for a delete element.EffectiveTimeQueryRequestBody carries the date/time for a query.ElementHeaderResponse is the response structure used on the OMAS REST API calls that return the header for a element.ElementHeadersResponse is a response object for passing back a list of element headers or an exception if the request failed.FFDCResponse is the top-level class for a response object used to return results on REST APIs.FFDCResponseBase provides the base class for REST API responses.RESTClient is responsible for issuing calls to the OMAS REST APIs.RESTClient is responsible for issuing calls to the OMAS REST APIs.FilterRequestBody is the request body structure used on OMAG REST API calls that passed a string that is used to filter responses.GetRequestBody describes the query options for a request that returns a single element.GUIDListResponse is the response structure used on the OMAS REST API calls that return a list of unique identifiers (guids) as a response.GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.IntegrationReportResponse is the response structure used on REST API calls that returns an ConnectorActivityReport object as a response.IntegrationReportsResponse is the response structure used on REST API calls that returns a list of ConnectorActivityReport objects as a response.MetadataElementSummariesResponse is the response structure used on the OMAS REST API calls that return a list of element identifiers as a response.MetadataElementSummaryResponse is a response object for passing back a single element or an exception if the request failed.MetadataRelationshipSummariesResponse is the response structure used on the OMAS REST API calls that return a list of relationships identifiers as a response.MetadataSourceRequestBody carries the parameters for marking an element, classification or relationship as external and for working with lineage/duplicate processing and effective time.NameListResponse is the response structure used on the OMAS REST API calls that return a list of names as a response.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.NewAttachmentRequestBody provides a structure used when creating new elements where the parent relationship is fixed.NewClassificationRequestBody describes the request body used when attaching classification to elements.NewElementRequestBody provides a structure used when creating new elements.NewExternalIdRequestBody provides a structure used when creating new elements.NewFeedbackRequestBody provides a structure used when creating new feedback elements.NewRelationshipRequestBody describes the request body used when linking elements together.NullRequestBody provides a empty request body object for POST requests that do not need to send additional parameters beyond the path variables.OCFConnectionResponse is the response structure used on REST API calls that return a Connection object as a response.OCFConnectorTypeResponse is the response structure used on REST API calls that return a ConnectorType object as a response.OpenMetadataRootElementResponse is the response structure used on the OMVS REST API calls that return an open metadata bean element as a response.OpenMetadataRootElementsResponse is the response structure used on the OMVS REST API calls that returns a list of open metadata bean elements.PropertiesResponse is the response structure used on REST API calls that return a property map object as a response.RegisteredOMAGServicesResponse provides an object for returning information about a service that is registered with an OMAG Server Platform.Provides a response object for returning information about a service that is registered in an OMAG Server Platform.RegisteredOMAGServicesResponse provides a response object for returning information about a list of services that are registered in an OMAG Server Platform.RelatedMetadataElementSummariesResponse is the response structure used on the OMAS REST API calls that return a list of element summaries as a response.ResultsRequestBody carries the date/time for a query along with other common search parameters.SearchStringRequestBody is the request body structure used on OMAG REST API calls that passes a regular expression to use as a search string.StringMapResponse is the response structure used on the OMAS REST API calls that return a map of names to description as a response.StringRequestBody is the request body structure used on OMAG REST API calls that passed a string.GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.NewClassificationRequestBody describes the request body used when updating classification properties.UpdateElementRequestBody describes the properties to update an open metadata element.UpdateRelationshipRequestBody describes the request body used when updating relationship propertiesUpdateElementRequestBody describes the properties to update an open metadata element.The response object for passing back a list of ValidMetadataValue properties or an exception if the request failed.The response structure used on the OMAS REST API calls that return the omf definition of the ValidMetadataValue.VoidResponse defines the response structure for the OMAS REST API calls that returns a void as a response.