Package org.odpi.openmetadata.frameworkservices.omf.rest
package org.odpi.openmetadata.frameworkservices.omf.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.
-
ClassesClassDescriptionActionTargetStatusRequestBody provides a structure for passing the properties that sit in the ActionTarget relationship.The response structure used on REST API calls that returns a list of AnchorSearchMatches objects as a response.The response structure used on the Open Survey Framework REST API calls that returns a AnchorSearchMatches element object as a response.AttributeTypeDefListResponse provides a simple bean for returning an array of AttributeTypeDefsThe response structure for an Open Survey Framework REST API call that returns an AttributeTypeDef object.ConsolidatedDuplicatesRequestBody provides a structure for passing the properties associated with consolidated duplicates.ExternalIdEffectiveTimeQueryRequestBody carries the date/time for a query.FindRelationshipRequestBody provides a structure for passing the properties for the find relationships request.FindRequestBody provides a structure for passing the properties for the find request.HistoryExternalIdentifiersRequestBody describes the start and stop time of the historical query.HistoryRequestBody describes the start and stop time of the historical query.IncidentReportRequestBody provides a structure for passing the properties for a new incident report.The response object for passing back a a list of correlation headers or an exception if the request failed.NewOpenMetadataClassificationRequestBody provides a structure for passing the properties for a new classification for a metadata element.NewOpenMetadataElementRequestBody provides a structure for passing the properties for a new metadata element.NewRelatedElementsRequestBody provides a structure for passing the properties for a new relationship between metadata elements.OMAGOMFAPIResponse provides a common header for Metadata Store Service managed rest to its REST API.OpenMetadataDeleteRequestBody carries the options for a delete element.The response structure used on the Open Survey Framework REST API calls that return the omf definition of the OpenMetadataElement.The response object for passing back a list of omf OpenMetadataElements or an exception if the request failed.The response structure used on the Open Survey Framework REST API calls that returns an OpenMetadataElementGraph object as a response.OpenMetadataRelationshipListResponse is a response object for passing back a list of omf OpenMetadataRelationship or an exception if the request failed.The response structure used on the OMAS REST API calls that return the omf definition of the relationship (OpenMetadataRelationship).TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.PeerDuplicatesRequestBody provides a structure for passing the properties associated with duplicates.The response object for passing back a list of omf OpenMetadataRelationship or an exception if the request failed.The response object for passing back a list of omf RelatedMetadataElementSummary or an exception if the request failed.StewardshipRequestBody provides a structure for passing the properties associated with stewardship actions.ActionRequestBody provides a structure for passing the properties for a new to do.The response structure used on the OMAS REST API calls that return the omf definition of the TranslationDetail.The response object for passing back a list of TranslationDetail properties or an exception if the request failed.TypeDefGalleryResponse provides the response structure for an OMRS REST API call that returns a TypeDefGallery.TypeDefListResponse provides a simple bean for returning a list of TypeDefs (or information to create a valid exception).TypeDefResponse provides the response structure for an OMRS API call that returns a TypeDefTypeLimitedFindRequest extends the paged find request to allow the caller to request results from only one type of instance.TypeLimitedHistoricalFindRequest provides an extension to the search parameters to include the point in time that the request should be based on.UniqueNameRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve an element by name.UpdateEffectivityDatesRequestBody provides a structure for passing the effectivity dates for a metadata element, classification or relationship.UpdateMetadataCorrelatorsRequestBody carries the correlation properties and effective time for a create, update or delete request.UpdatePropertiesRequestBody provides a structure for passing the properties for updating metadata elements, relationships or classifications.UpdateStatusRequestBody provides a structure for passing the updated status and effectivity dates for a metadata element.The response object for passing back a list of ValidMetadataValue properties or an exception if the request failed.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.