Package org.odpi.openmetadata.accessservices.communityprofile.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.

Class Summary

Class	Description
ActorProfileListResponse	ActorProfileListResponse is the response structure used on the OMAS REST API calls that return a a list of profile elements.
ActorProfileRequestBody	ActorProfileRequestBody provides the request body payload for working on ActorProfile entities.
ActorProfileResponse	ActorProfileResponse is the response structure used on the OMAS REST API calls that return a ActorProfileElement object as a response.
AppointmentRequestBody	AppointmentRequestBody provides the request body payload for linking roles to people.
AssetCollectionRequestBody	AssetCollectionRequestBody defines the properties used to create an asset connector anchor object.
AssetListResponse	AssetListResponse returns a list of assets from the server.
CommunityProfileOMASAPIRequestBody	CommunityProfileOMASAPIRequestBody provides a common header for Community Profile OMAS request bodies for its REST API.
CommunityProfileOMASAPIResponse	CommunityProfileOMASAPIResponse provides a common header for Community Profile OMAS managed rest to its REST API.
ContactMethodRequestBody	ContactMethodRequestBody provides the request body payload for working on ContactMethod entities.
DigitalLocationRequestBody	DigitalLocationRequestBody carries the parameters for marking a location as a digital (cyber) location.
EffectiveDatesRequestBody	MetadataSourceRequestBody carries the parameters for marking an asset or schema as external.
EffectiveTimeRequestBody	EffectiveTimeRequestBody carries the date/time for a query.
ElementStubsResponse	ElementStubListResponse is the response structure used on the OMAS REST API calls that return a list of element identifiers as a response.
FixedLocationRequestBody	FixedLocationRequestBody carries the parameters for marking a location as a fixed physical location.
LocationResponse	LocationResponse is a response object for passing back a single location object.
LocationsResponse	LocationsResponse is a response object for passing back a list of location objects.
MetadataSourceRequestBody	MetadataSourceRequestBody carries the parameters for marking an asset or schema as external.
MetadataSourceResponse	MetadataSourceResponse is the response structure used on the OMAS REST API calls that return a MetadataSourceElement object as a response.
MyProfileRequestBody	MyProfileRequestBody provides a structure for passing personal details over a REST API.
PersonalProfileListResponse	PersonalProfileListResponse is the response structure used on the OMAS REST API calls that return a a list of personal profile objects.
PersonalProfileRequestBody	PersonalDetailsRequestBody provides a structure for passing personal details over a REST API.
PersonalProfileResponse	PersonalProfileResponse is the response structure used on the OMAS REST API calls that return a PersonalProfileUniverse object as a response.
PersonalProfileValidatorRequestBody	PersonalDetailsRequestBody provides a structure for passing personal details over a REST API.
PersonRoleAppointeeListResponse	PersonRoleListResponse is the response structure used on the OMAS REST API calls that return a a list of person role elements.
PersonRoleListResponse	PersonRoleListResponse is the response structure used on the OMAS REST API calls that return a a list of person role elements.
PersonRoleRequestBody	PersonRoleRequestBody provides the request body payload for working on PersonRole entities.
PersonRoleResponse	PersonRoleResponse is the response structure used on the OMAS REST API calls that return a PersonRoleElement object as a response.
ProfileIdentityRequestBody	ContactMethodRequestBody provides the request body payload for working on ContactMethod entities.
SecureLocationRequestBody	SecureLocationRequestBody carries the parameters for marking a location as secure.
SecurityGroupResponse	SecurityGroupResponse is the response structure used on the OMAS REST API calls that return the properties for a security group.
SecurityGroupsResponse	SecurityGroupsResponse is a response object for passing back a a list of security groups or an exception if the request failed.
TeamPlayerRequestBody	TeamPlayerRequestBody provides the request body payload for linking roles to teams.
UserIdentityListResponse	UserIdentityListResponse is the response structure used on the OMAS REST API calls that return a a list of user identity elements.
UserIdentityRequestBody	UserIdentityRequestBody provides the request body payload for working on UserIdentity entities and their link to profiles.
UserIdentityResponse	UserIdentityResponse is the response structure used on the OMAS REST API calls that return a UserIdentityElement object as a response.