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.
-
ClassesClassDescriptionActorProfileListResponse is the response structure used on the OMAS REST API calls that return a list of profile elements.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.AppointmentRequestBody provides the request body payload for linking roles to people.AssetCollectionRequestBody defines the properties used to create an asset connector anchor object.AssetListResponse returns a list of assets from the server.ClassificationRequestBody describes the request body used when attaching classification to elements.CommunityListResponse is the response structure used on the OMAS REST API calls that return a list of community elements.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.CommunityResponse is the response structure used on the OMAS REST API calls that return a CommunityElement object as a response.ContactMethodRequestBody provides the request body payload for working on ContactMethod entities.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.ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.LocationListResponse is a response object for passing back a list of location objects.LocationResponse is a response object for passing back a single location object.MetadataSourceResponse is the response structure used on the OMAS REST API calls that return a MetadataSourceElement object as a response.MyProfileRequestBody provides a structure for passing personal details over a REST API.PersonalProfileListResponse is the response structure used on the OMAS REST API calls that return a list of personal profile objects.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.PersonalDetailsRequestBody provides a structure for passing personal details over a REST API.PersonRoleListResponse is the response structure used on the OMAS REST API calls that return a a list of person role elements.PersonRoleListResponse is the response structure used on the OMAS REST API calls that return a list of person role elements.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.ReferenceableRequestBody describes the request body used when working with referenceables.RelatedElementListResponse is a response object for passing back a list of relatedElement objects.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.RelationshipRequestBody describes the request body used when linking elements together.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.TeamPlayerRequestBody provides the request body payload for linking roles to teams.TemplateRequestBody carries the parameters for creating a new asset using a template.UserIdentityListResponse is the response structure used on the OMAS REST API calls that return a list of user identity elements.UserIdentityResponse is the response structure used on the OMAS REST API calls that return a UserIdentityElement object as a response.ValidValueListResponse is a response object for passing back a list of valid value objects.ValidValueResponse is a response object for passing back a single valid value object.