Package org.odpi.openmetadata.accessservices.securitymanager.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.ActorProfileResponse ActorProfileResponse is the response structure used on the OMAS REST API calls that return a ActorProfileElement object as a response.ClassificationRequestBody ClassificationRequestBody describes the request body used when attaching classification to elements.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.MetadataSourceRequestBody MetadataSourceRequestBody carries the parameters for marking an asset or schema as external.PathNameRequestBody PathNameRequestBody carries the parameters for creating a new FileFolder asset.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.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.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.SecurityManagerOMASAPIRequestBody SecurityManagerOMASAPIRequestBody provides a common header for Security Manager OMAS request bodies for its REST API.SecurityManagerOMASAPIResponse SecurityManagerOMASAPIResponse provides a common header for Security Manager OMAS managed rest to its REST API.SecurityManagerRequestBody SecurityManagerProperties describes the properties of a security manager.TemplateRequestBody TemplateRequestBody carries the parameters for creating a new asset using a template.UserIdentitiesResponse UserIdentitiesResponse is a response object for passing back a a list of user identities or an exception if the request failed.UserIdentityRequestBody UserIdentityRequestBody carries the parameters for creating a new user identity or updating an existing one.UserIdentityResponse UserIdentityResponse is the response structure used on the OMAS REST API calls that return the properties for a user identity.