Package org.odpi.openmetadata.frameworkservices.gaf.rest
package org.odpi.openmetadata.frameworkservices.gaf.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.CompletionStatusRequestBody provides a structure for passing the properties to record that a governance service finished a governance action.ConsolidatedDuplicatesRequestBody provides a structure for passing the properties associated with consolidated duplicates.DeleteRequestBody provides a structure for passing the qualified name of an object to be deleted.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.FindRequestBody provides a structure for passing the properties for the find request.GovernanceActionProcessRequestBody provides a structure for passing the properties for initiating a new instance of a governance action process.GovernanceActionRequestBody provides a structure for passing the properties for a new governance action.IncidentReportRequestBody provides a structure for passing the properties for a new incident report.MetadataSourceRequestBody carries the parameters for marking an element, classification or relationship as external.NewClassificationRequestBody provides a structure for passing the properties for a new classification for a metadata element.NewMetadataElementRequestBody 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.OMAGGAFAPIResponse provides a common header for Metadata Store Service managed rest to its REST API.OpenMetadataElementResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the OpenMetadataElement.OpenMetadataElementsResponse is a response object for passing back a list of GAF OpenMetadataElements or an exception if the request failed.PeerDuplicatesRequestBody provides a structure for passing the properties associated with duplicates.RelatedMetadataElementsListResponse is a response object for passing back a list of GAF RelatedMetadataElements or an exception if the request failed.RelatedMetadataElementsListResponse is a response object for passing back a list of GAF RelatedMetadataElements or an exception if the request failed.RelatedMetadataElementsResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the relationship (RelatedMetadataElements).RequestTypeRequestBody provides a structure for passing a requestType and requestParameters as a request body over a REST API.StatusRequestBody provides a structure for passing a new GovernanceActionStatus.StewardshipRequestBody provides a structure for passing the properties associated with stewardship actions.ToDoRequestBody provides a structure for passing the properties for a new to do.TranslationDetailResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the TranslationDetail.TranslationListResponse is a response object for passing back a list of TranslationDetail properties or an exception if the request failed.UpdateEffectivityDatesRequestBody provides a structure for passing the effectivity dates for a metadata element, classification or relationship.UpdatePropertiesRequestBody provides a structure for passing the properties for updating metadata elements, relationships or classifications.UpdateRequestBody provides a structure for passing the common request parameters for updating metadata elements, relationships or classifications.UpdateStatusRequestBody provides a structure for passing the updated status and effectivity dates for a metadata element.ValidMetadataValueListResponse is a response object for passing back a list of ValidMetadataValue properties or an exception if the request failed.ValidMetadataValueResponse is the response structure used on the OMAS REST API calls that return the GAF definition of the ValidMetadataValue.