Package org.odpi.openmetadata.accessservices.governanceprogram.rest

package org.odpi.openmetadata.accessservices.governanceprogram.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
AppointmentRequestBody	AppointmentRequestBody provides a structure for appointing a person to a role.
CertificateIdRequestBody	CertificateIdRequestBody provides a structure for the unique certificate identifier.
CertificationListResponse	CertificationTypeListResponse is the response structure used on the OMAS REST API calls that return a list of certifications as a response.
CertificationTypeListResponse	CertificationTypeListResponse is the response structure used on the OMAS REST API calls that return a list of certification types as a response.
CertificationTypeRequestBody	CertificationTypeRequestBody provides a structure used when creating certification types.
CertificationTypeResponse	CertificationTypeResponse is the response structure used on the OMAS REST API calls that returns a certification type object as a response.
ClassificationRequestBody	ClassificationRequestBody describes the request body used when attaching classification to elements.
ElementStubListResponse	ElementStubListResponse is the response structure used on the OMAS REST API calls that return a list of element identifiers as a response.
ExternalReferenceIdRequestBody	ExternalReferenceIdRequestBody provides a structure for the unique external reference identifier.
ExternalReferenceListResponse	ExternalReferenceListResponse is the response structure used on the OMAS REST API calls that return a list of external references as a response.
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.
ExternalSourceRequestBody	ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
GovernanceDefinitionGraphResponse	GovernanceDefinitionGraphResponse is the response structure used on the OMAS REST API calls that returns a governance definition graph object as a response.
GovernanceDefinitionListResponse	GovernanceDefinitionListResponse is the response structure used on the OMAS REST API calls that return a list of governance definitions as a response.
GovernanceDefinitionRequestBody	GovernanceDefinitionRequestBody provides a structure used when creating governance definitions.
GovernanceDefinitionResponse	GovernanceDefinitionResponse is the response structure used on the OMAS REST API calls that returns a governance definition object as a response.
GovernanceDomainListResponse	GovernanceDomainListResponse is the response structure used on the OMAS REST API calls that return a list of governance domain definitions as a response.
GovernanceDomainResponse	GovernanceDomainResponse is the response structure used on the OMAS REST API calls that returns a governance domain definition object as a response.
GovernanceDomainSetListResponse	GovernanceDomainSetListResponse is the response structure used on the OMAS REST API calls that return a list of governance domain definition sets as a response.
GovernanceDomainSetResponse	GovernanceDomainResponse is the response structure used on the OMAS REST API calls that returns a governance domain definition object as a response.
GovernanceLevelIdentifierListResponse	GovernanceLevelIdentifierListResponse is the response structure used on the OMAS REST API calls that return a list of governance classification level identifiers as a response.
GovernanceLevelIdentifierResponse	GovernanceLevelIdentifierSetResponse is the response structure used on the OMAS REST API calls that returns a governance classification level identifier object as a response.
GovernanceLevelIdentifierSetListResponse	GovernanceLevelIdentifierSetListResponse is the response structure used on the OMAS REST API calls that return a list of governance classification level identifier sets as a response.
GovernanceLevelIdentifierSetResponse	GovernanceLevelIdentifierSetResponse is the response structure used on the OMAS REST API calls that returns a governance classification level identifier set object as a response.
GovernanceMetricImplementationListResponse	GovernanceMetricListResponse is the response structure used on the OMAS REST API calls that return a list of governance metrics along with details of the data sets where measurements are kept as a response.
GovernanceMetricListResponse	GovernanceMetricListResponse is the response structure used on the OMAS REST API calls that return a list of governance metric as a response.
GovernanceMetricResponse	GovernanceMetricResponse is the response structure used on the OMAS REST API calls that returns a governance metric object as a response.
GovernanceProgramOMASAPIRequestBody	GovernanceProgramOMASAPIRequestBody provides a common header for Governance Program OMAS request bodies for its REST API.
GovernanceProgramOMASAPIResponse	GovernanceProgramOMASAPIResponse provides a common header for Governance Program OMAS managed rest to its REST API.
GovernanceRoleAppointeeListResponse	GovernanceRoleAppointeeListResponse is the response structure used on the OMAS REST API calls that return a list of governance roles and their appointees as a response.
GovernanceRoleHistoryResponse	GovernanceRoleHistoryResponse is the response structure used on the OMAS REST API calls that return a governance role object with details of who is and has been appointed to the role as a response.
GovernanceRoleListResponse	GovernanceRoleListResponse is the response structure used on the OMAS REST API calls that return a list of governance roles as a response.
GovernanceRoleRequestBody	GovernanceDefinitionRequestBody provides a structure used when creating governance definitions.
GovernanceRoleResponse	GovernanceRoleResponse is the response structure used on the OMAS REST API calls that returns a governance role object as a response.
GovernanceStatusIdentifierResponse	GovernanceStatusIdentifierSetResponse is the response structure used on the OMAS REST API calls that returns a governance classification level identifier object as a response.
GovernanceStatusIdentifierSetListResponse	GovernanceStatusIdentifierSetListResponse is the response structure used on the OMAS REST API calls that return a list of governance classification level identifier sets as a response.
GovernanceStatusIdentifierSetResponse	GovernanceStatusIdentifierSetResponse is the response structure used on the OMAS REST API calls that returns a governance classification level identifier set object as a response.
GovernanceStatusRequestBody	GovernanceDefinitionRequestBody provides a structure used when creating governance definitions.
GovernanceZoneDefinitionResponse	GovernanceZoneDefinitionResponse is the response structure used on the OMAS REST API calls that return the properties for a governance zone with the linked governance definitions.
GovernanceZoneListResponse	GovernanceZoneListResponse is the response structure used on the OMAS REST API calls that return a list of governance zones.
GovernanceZoneResponse	GovernanceZoneResponse is the response structure used on the OMAS REST API calls that return the properties for a governance zone.
LicenseIdRequestBody	LicenseIdRequestBody provides a structure for the unique certificate identifier.
LicenseListResponse	LicenseListResponse is the response structure used on the OMAS REST API calls that return a list of licenses as a response.
LicenseTypeListResponse	LicenseTypeListResponse is the response structure used on the OMAS REST API calls that return a list of license types as a response.
LicenseTypeRequestBody	LicenseTypeRequestBody provides a structure used when creating license types.
LicenseTypeResponse	LicenseTypeResponse is the response structure used on the OMAS REST API calls that returns a license type object as a response.
PersonRoleListResponse	PersonRoleListResponse is the response structure used on the OMAS REST API calls that return a list of person role elements.
PersonRoleResponse	PersonRoleResponse is the response structure used on the OMAS REST API calls that return a PersonRoleElement object as a response.
ReferenceableRequestBody	RelationshipRequestBody describes the request body used when linking elements together.
RelatedElementListResponse	RelatedElementListResponse is a response object for passing back a list of relatedElement objects.
RelationshipRequestBody	RelationshipRequestBody describes the request body used when linking elements together.
SubjectAreaDefinitionResponse	SubjectAreaDefinitionResponse is the response structure used on the OMAS REST API calls that return the properties for a subject area with the linked governance definitions.
SubjectAreaListResponse	SubjectAreaListResponse is the response structure used on the OMAS REST API calls that return a list of subject area descriptions.
SubjectAreaResponse	SubjectAreaResponse is the response structure used on the OMAS REST API calls that return the properties for a subject area.