All Classes and Interfaces
Class
Description
The ActorProfileElement describes an individual, system, team or organization.
ActorProfileListResponse is the response structure used on the OMAS REST API calls that return
a list of profile elements.
The ActorProfileProperties describes the common properties of a Personal Profile, IT Profile and Team Profile.
ActorProfileRequestBody provides the request body payload for working on ActorProfile entities.
ActorProfileResponse is the response structure used on the OMAS REST API calls that return a
ActorProfileElement object as a response.
AdjacentLocationProperties describes the properties for the AdjacentLocation relationship between adjacent locations.
ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
AppointmentRequestBody provides the request body payload for linking roles to people.
AssetCollectionMember describes an asset that is a member of an individual's my-assets collection.
AssetCollectionRequestBody defines the properties used to create an asset connector anchor object.
AssetListResponse returns a list of assets from the server.
AssetLocationProperties describes the properties for the AssetLocation relationship between an asset and a location.
AssetProperties describes an asset.
AssignmentScopeProperties provides a details of the scope of work/influence expected by the assigned actor(s).
ClassificationProperties provides the base class for classification items.
ClassificationRequestBody describes the request body used when attaching classification to elements.
CollectionElement contains the properties and header for a collection retrieved from the metadata repository.
The CollectionManagementInterface adds methods for managing collections that can be attached to communities
and personal profiles.
CollectionMember describes a member of a collection.
CollectionMemberHeader describes the common properties of a item in a favorite things list.
CollectionOrder specifies the sequencing to use in a specific collection.
CollectionProperties describes the core properties of a collection.
CollectionStatus specifies which subset of a collection should be returned.
CommentElement contains the properties and header for a comment retrieved from the metadata repository.
The CommentProperties bean stores information about a comment connected to an asset.
The CommentType allows comments to be used to ask and answer questions as well as make suggestions and
provide useful information to other users.
CommunityCollectionMember describes a community that is a member of an individual's my-communities collection.
CommunityElement contains the properties and header for a community.
CommunityForum is used to maintain the content for a community forum.
CommunityForumContribution is used to add an entry to a community forum.
CommunityListResponse is the response structure used on the OMAS REST API calls that return
a list of community elements.
The CommunityManagementInterface provides methods for managing communities, their membership and content.
CommunityMembershipElement describes an individual who is a member of a community.
CommunityMembershipProperties provides a details of the purpose (and privileges) of the membership role.
CollectionStatus specifies which subset of a collection should be returned.
The CommunityProfileAuditCode is used to define the message content for the OMRS Audit Log.
CommunityProfileCheckedExceptionBase provides a checked exception for reporting errors found when using
the Community Profile OMAS services.
The CommunityProfileErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with
the Community Profile OMAS Services.
CommunityProfileEventHeader provides a common base for all events from the access service.
CommunityProfileEventInterface defines how a client gets access to the events produced by the Community Profile OMAS.
CommunityProfileEventListener is the interface that a client implements to
register to receive the events from the Community Profile OMAS's out topic.
CommunityProfileOMASAPIRequestBody provides a common header for Community Profile OMAS request bodies for its REST API.
CommunityProfileOMASAPIResponse provides a common header for Community Profile OMAS managed rest to its REST API.
CommunityProfileOutboundEvent describes the structure of the events emitted by the Community Profile OMAS.
CommunityProfileOutboundEventType describes the different types of events produced by the Community Profile OMAS.
CommunityProperties describes the core properties of a community.
CommunityResponse is the response structure used on the OMAS REST API calls that return a
CommunityElement object as a response.
ContactMethodElement contains the properties and header for a contract method retrieved from the metadata repository.
ContactMethodProperties describes a single mechanism that can be used to contact an individual.
ContactMethodRequestBody provides the request body payload for working on ContactMethod entities.
ContactMethodType specifies the contact mechanism to use to contact an individual.
The ContributionRecord holds the information about an individual's contribution to the open metadata
ecosystem.
ContributionRecordElement contains the properties and header for a contribution record retrieved from the metadata repository.
DigitalLocationProperties carries the parameters for marking a location as a digital (cyber) location.
ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
EffectiveTimeRequestBody carries the date/time for a query.
ElementStubListResponse is the response structure used on the OMAS REST API calls that return a
list of element identifiers as a response.
ExternalReferenceElement stores information about an link to an external resource that is relevant to this element.
ExternalReferenceManagementInterface defines the Java API for managing external references.
ExternalReferenceProperties stores information about an link to an external resource that is relevant to a personal
profile or a community.
ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
FixedLocationProperties carries the parameters for marking a location as a fixed physical location.
GovernanceDefinitionProperties provides the base class for many of the definitions that define the data strategy
and governance program.
GovernanceDefinitionStatus indicates whether the definition is complete and operational or in a state that means
it is either under development or obsolete.
InformalTagElement contains the properties and header for an informal retrieved from the metadata repository.
InformalTagProperties stores information about a tag connected to an asset.
LikeElement contains the properties and header for a like entity retrieved from the metadata repository.
The LikeProperties properties object records a single user's "like" of an asset.
LocationElement contains the properties and header for a location definition retrieved from the metadata repository.
LocationListResponse is a response object for passing back a list of location objects.
LocationManagementInterface defines the client side interface for the Community Profile OMAS that is relevant for managing definitions of locations.
LocationProperties is a class for representing a generic location.
LocationResponse is a response object for passing back a single location object.
MetadataElement is the common interface for all metadata elements.
MetadataSourceElement contains the properties and header for a software server capability retrieved from the metadata repository.
MetadataSourceInterface is the interface used to define information about the third party technologies that
an integration daemon is extracting metadata from.
MetadataSourceProperties describe the properties for a capability that is supplying profile
information to the Community Profile OMAS.
MetadataSourceResponse is the response structure used on the OMAS REST API calls that return a
MetadataSourceElement object as a response.
MyFavouriteCollectionsInterface covers the management of the MyAssets, MyProjects and MyCommunities
collections associated with a person's personal profile.
MyPersonalNetworkInterface provides interfaces to query the personal network of the individual.
MyPersonalNotesInterface provides the ability for a person to create and manage their personal notes.
MyPersonalProfileInterface covers the management of a user's personal profile.
MyProfileRequestBody provides a structure for passing personal details over a REST API.
MyRolesAndActionsInterface covers the ability to query a person's roles and any actions (to dos) assigned
to those roles.
NestedLocationProperties describes the properties for the NestedLocation relationship between locations.
The NoProfileForUserException is thrown by the OMAS when a userId passed on a request does not have an associated
actor profile.
NoteLogEntryElement contains the properties and header for an entry in a note log such as a persona note log or a community forum.
NoteLogEntryProperties covers the entries in a community forum and personal notes since they are based on a note log.
NoteLogHeaderElement contains the properties and header for the root of a note log such as a personal note log or a community forum.
NoteLogHeaderProperties covers the properties that are common between a community forum and a persona note log.
OrganizationManagementInterface defines the client interface for setting up the profiles, roles and relationships for an organization.
Personal message is a comment added to a personal profile.
PersonalNote is used to add a personal note to a personal profile.
PersonalNoteLog is used to maintain the list of personal notes for a personal profile.
The PersonalProfileElement describes an individual who has (or will be) appointed to one of the
governance roles defined in the governance program.
PersonalProfileListResponse is the response structure used on the OMAS REST API calls that return
a list of personal profile objects.
PersonalProfileManagementInterface defines the client interface for an administrator setting up a profile for an
individual.
The PersonalProfileProperties describes an individual.
PersonalDetailsRequestBody provides a structure for passing personal details over a REST API.
PersonalProfileResponse is the response structure used on the OMAS REST API calls that return a
PersonalProfileUniverse object as a response.
PersonalProfileUniverse contains the properties and header for a personal profile
retrieved from the metadata repository along with details of the contribution record, user ids, contact methods, peers and
roles that the profile is linked to.
PersonalDetailsRequestBody provides a structure for passing personal details over a REST API.
PersonalRoleElement contains the properties and header for a person role assigned to a profile retrieved from the metadata repository.
PersonalRoleProperties provides a structure for describe a role assigned to a person.
PersonRoleAppointee describes an individual's appointment to a specific governance role.
PersonRoleListResponse is the response structure used on the OMAS REST API calls that return a
a list of person role elements.
PersonalRoleElement contains the properties and header for a person role assigned to a profile retrieved from the metadata repository.
PersonRoleListResponse is the response structure used on the OMAS REST API calls that return
a list of person role elements.
PersonRoleProperties covers a role that has been defined in an organization.
PersonRoleRequestBody provides the request body payload for working on PersonRole entities.
PersonRoleResponse is the response structure used on the OMAS REST API calls that return a
PersonRoleElement object as a response.
ProfileIdentityElement contains the properties and header for a relationship between a profile and a user identity retrieved
from the metadata repository.
ProfileIdentityProperties describes the properties for the ProfileIdentity relationship between a profile
and a user identity.
ProfileLocationElement contains the properties and header for a relationship between a profile and a user identity retrieved
from the metadata repository.
ProfileLocationProperties describes the properties for the ProfileLocation relationship between a profile
and a location.
ProjectCollectionMember describes a project that is a member of an individual's my-projects collection.
ProjectProperties describes a project.
RatingElement contains the properties and header for a rating retrieved from the metadata repository.
RatingProperties stores information about a rating connected to an asset.
Many open metadata entities are referenceable.
ReferenceableRequestBody describes the request body used when working with referenceables.
ReferenceValueAssignmentProperties is a java bean used to create a link between a valid value and a referenceable item
to enable the valid value to be used as a semiformal tag/classifier.
RelatedElement contains the properties and header for a relationship retrieved from the metadata repository along with the stub
of the related element.
RelatedElementListResponse is a response object for passing back a list of relatedElement objects.
Defines the interface that is common to multiple element types
RelationshipElement contains the properties and header for a relationship retrieved from the metadata repository.
RelationshipElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a relationship.
RelationshipElementsResponse is a response object for passing back a list of relationships
or an exception if the request failed.
RelationshipProperties provides the base class for relationships items.
RelationshipRequestBody describes the request body used when linking elements together.
ResourceElement contains the properties and header for a referenceable retrieved from the metadata repository.
ResourceListProperties provides a details of why an element providing resources (such as a community) has been attached to an initiative
such as a governance domain.
ResourceProperties provides a summary of a resource linked to a community or personal profile or something similar.
SecureLocationProperties carries the parameters for marking a location as secure.
SecurityGroupElement is the superclass used to return the common properties of a governance definition stored in the
open metadata repositories.
SecurityGroupProperties defines a security group technical control.
SecurityGroupResponse is the response structure used on the OMAS REST API calls that return the properties
for a security group.
SecurityGroupsResponse is a response object for passing back a a list of security groups
or an exception if the request failed.
StakeholderProperties provides a details of a stakeholder for an initiative.
A StarRating defines the rating that a user has placed against an element.
TeamMembershipElement contains the properties and header for a role that shows a person is a leader or a member of
a team as retrieved from the metadata repository.
TeamPlayerRequestBody provides the request body payload for linking roles to teams.
TeamProfileElement contains the properties and header for a team profile retrieved from the metadata repository.
The TeamProfileProperties describes an team of people.
TemplateProperties defined the properties that can be overridden from the template object
when creating an object from a template.
TemplateRequestBody carries the parameters for creating a new asset using a template.
ToDoElement contains the properties and header for a "to do" (informal task) retrieved from the metadata repository.
The "To Do" describes an action - it may be assigned to a person role (see PersonRoleAction).
ToDoStatus defines the progress towards completing a to do.
UserIdentityElement contains the properties and header for a user identity retrieved from the metadata repository.
UserIdentityListResponse is the response structure used on the OMAS REST API calls that return
a list of user identity elements.
UserIdentityManagementInterface provides administrative function to alter the association between
a profile (either personal profile or IT profile) and a user identity.
UserIdentityProperties describes an element that is linked to a single userId.
UserIdentityResponse is the response structure used on the OMAS REST API calls that return a
UserIdentityElement object as a response.
ValidValueAssignmentProperties describes the properties between a referenceable and its valid values.
ValidValueElement contains the properties and header for a valid value definition or set entity retrieved from the metadata repository.
ValidValueListResponse is a response object for passing back a list of valid value objects.
The ValidValueManagementInterface provides methods for managing valid values.
ValidValueMembershipProperties provides a flag to indicate if this value is the default value for the set.
ValidValueProperties provides the common super class for ValidValueSet and ValidValueDefinition.
ValidValueResponse is a response object for passing back a single valid value object.
WatchStatus specifies whether changes to assets in an asset collection should be
passed as notifications to the actor who's profile is linked to the collection.