Package org.odpi.openmetadata.viewservices.myprofile.rest


package org.odpi.openmetadata.viewservices.myprofile.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
    EffectiveTimeQueryRequestBody carries the date/time for a query.
    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.
    ReferenceableRequestBody describes the request body used to create/update properties in referenceables.
    ReferenceableUpdateRequestBody carries the correlation properties, readVersionIdentifier and effective time for a create (with parent), update or delete requests.
    RelationshipRequestBody describes the request body used when linking elements together.
    ToDoListResponse is the response structure used on the OMAS REST API calls that return a list of to do objects.
    ToDoRequestBody provides a structure for passing to do details over a REST API.
    ToDoResponse is the response structure used on the OMAS REST API calls that returns a "to do" object as a response.
    ToDoStatusRequestBody provides a structure for passing the status.