Package org.odpi.openmetadata.accessservices.communityprofile.rest

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.

Classes

Class	Description
ActorProfileListResponse	ActorProfileListResponse is the response structure used on the OMAS REST API calls that return 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.
ClassificationRequestBody	ClassificationRequestBody describes the request body used when attaching classification to elements.
CommunityListResponse	CommunityListResponse is the response structure used on the OMAS REST API calls that return a list of community elements.
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.
CommunityResponse	CommunityResponse is the response structure used on the OMAS REST API calls that return a CommunityElement object as a response.
ContactMethodRequestBody	ContactMethodRequestBody provides the request body payload for working on ContactMethod entities.
EffectiveDatesRequestBody	ExternalSourceRequestBody 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.
ExternalSourceRequestBody	ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
LocationListResponse	LocationListResponse is a response object for passing back a list of location objects.
LocationResponse	LocationResponse is a response object for passing back a single location object.
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 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 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.
ReferenceableRequestBody	ReferenceableRequestBody describes the request body used when working with referenceables.
RelatedElementListResponse	RelatedElementListResponse is a response object for passing back a list of relatedElement objects.
RelationshipElementResponse	RelationshipElementResponse is the response structure used on the OMAS REST API calls that return the properties for a relationship.
RelationshipElementsResponse	RelationshipElementsResponse is a response object for passing back a list of relationships or an exception if the request failed.
RelationshipRequestBody	RelationshipRequestBody describes the request body used when linking elements together.
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.
TemplateRequestBody	TemplateRequestBody carries the parameters for creating a new asset using a template.
UserIdentityListResponse	UserIdentityListResponse is the response structure used on the OMAS REST API calls that return a list of user identity elements.
UserIdentityResponse	UserIdentityResponse is the response structure used on the OMAS REST API calls that return a UserIdentityElement object as a response.
ValidValueListResponse	ValidValueListResponse is a response object for passing back a list of valid value objects.
ValidValueResponse	ValidValueResponse is a response object for passing back a single valid value object.