Package org.odpi.openmetadata.commonservices.ffdc.rest

package org.odpi.openmetadata.commonservices.ffdc.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.

Related Packages

Package	Description
org.odpi.openmetadata.commonservices.ffdc	The FFDC Services provide common exceptions and error handling for service running in OMAG Servers.
org.odpi.openmetadata.commonservices.ffdc.exceptions
org.odpi.openmetadata.commonservices.ffdc.properties	Beans used in providing FFDC context and support to open metadata and governance.

Class	Description
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.
ActorProfilesResponse	ActorProfilesResponse is the response structure used on the OMAS REST API calls that return a list of profile elements.
AnnotationResponse	AnnotationResponse is the response structure used on the OMAS REST API calls that return a Annotation object as a response.
AnnotationsResponse	AnnotationsResponse is the response structure used on OMAS REST API calls that return a list of Annotations objects as a response.
AnnotationStatusRequestBody	AnnotationStatusRequestBody provides a structure for passing the annotation status of an Annotation.
APIManagerRequestBody	APIManagerRequestBody describes the basic properties of an API manager's software server capability.
APIOperationRequestBody	APIOperationRequestBody describes the properties of the API operation plus the optional identifiers for an owning software server capability.
APIOperationResponse	APIOperationResponse is a response object for passing back a single APIOperation element or an exception if the request failed.
APIOperationsResponse	APIOperationsResponse is a response object for passing back a a list of APIOperations or an exception if the request failed.
APIParameterListRequestBody	APIParameterListRequestBody describes the properties of the API parameter list plus the optional identifiers for an owning software server capability.
APIParameterListResponse	APIParameterListResponse is a response object for passing back a single APIParameterList element or an exception if the request failed.
APIParameterListsResponse	APIParameterListsResponse is a response object for passing back a a list of APIParameterLists or an exception if the request failed.
APIParameterResponse	APIParameterResponse is a response object for passing back a single APIParameter element or an exception if the request failed.
APIParametersResponse	APIParametersResponse is a response object for passing back a a list of APIParameters or an exception if the request failed.
APIRequestBody	APIRequestBody describes the properties of the API plus the optional identifiers for an owning software server capability.
APIResponse	APIResponse is a response object for passing back a single API element or an exception if the request failed.
APIsResponse	APIsResponse is a response object for passing back a a list of APIs or an exception if the request failed.
ApplicationRequestBody	ApplicationRequestBody describes the basic properties of an application's software server capability.
AppointeesResponse	PersonRolesResponse is the response structure used on the OMAS REST API calls that return a a list of person role elements.
AppointmentRequestBody	AppointmentRequestBody provides the request body payload for linking roles to people.
ArchiveRequestBody	ArchiveRequestBody carries the parameters for marking an asset as archived (or deleted).
AssetConnectionRequestBody	AssetConnectionRequestBody carries the parameters for creating a new relationship between an asset and a connection.
AssetElementResponse	AssetElementResponse is the response structure used on the OMAS REST API calls that return a AssetElement bean object as a response.
AssetElementsResponse	AssetElementsResponse returns a list of assets from the server.
AssetExtensionsRequestBody	AssetExtensionsRequestBody provides the request body payload for relationships between assets.
AssetGraphResponse	AssetGraphResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns an AssetGraph object as a response.
AssetLineageGraphResponse	AssetLineageGraphResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns an AssetLineageGraph object as a response.
AssetRelationshipsResponse	AssetRelationshipsResponse is a response object for passing back a list of relationships between assets or an exception if the request failed.
AssetRequestBody	AssetRequestBody describes the properties of the asset for creation and update.
AssetSearchMatchesListResponse	AssetSearchMatchesListResponse returns the list of results from an asset domain search.
BooleanRequestBody	BooleanRequestBody is the request body structure used on OMAG REST API calls that passed a boolean flag.
BooleanResponse	BooleanResponse is the response structure used on OMAG REST API calls that return a boolean response.
CalculatedValueClassificationRequestBody	CalculatedValueClassificationRequestBody is used to identify the schema elements that are calculated (derived) rather than stored.
CertificateIdRequestBody	CertificateIdRequestBody provides a structure for the unique certificate identifier.
CertificationsResponse	CertificationTypesResponse is the response structure used on the OMAS REST API calls that return a list of certifications as a response.
CertificationTypeRequestBody	CertificationTypeRequestBody provides a structure used when creating certification types.
CertificationTypeResponse	CertificationTypeResponse is the response structure used on the OMAS REST API calls that returns a certification type object as a response.
CertificationTypesResponse	CertificationTypesResponse is the response structure used on the OMAS REST API calls that return a list of certification types as a response.
ClassificationRequestBody	ClassificationRequestBody describes the request body used when attaching classification to elements.
CollectionMemberResponse	CollectionMemberResponse is the response structure used on the OMAS REST API calls that return a CollectionMember object as a response.
CollectionMembersResponse	CollectionMembersResponse is the response structure used on the OMAS REST API calls that return a list of collection membership elements.
CollectionResponse	CollectionResponse is the response structure used on the OMAS REST API calls that return a CollectionElement object as a response.
CollectionsResponse	CollectionsResponse is the response structure used on the OMAS REST API calls that return a list of collection elements.
CombinedSchemaRequestBody	CombinedSchemaRequestBody carries the parameters for created a new schema to attach to an asset.
CommentRequestBody	The CommentRequestBody bean stores information about a comment connected to an asset.
CommentTypesResponse	CommentTypesResponse is a response object for passing back a list of enum values or an exception if the request failed.
CommunitiesResponse	CommunitiesResponse is the response structure used on the OMAS REST API calls that return a list of community elements.
CommunityResponse	CommunityResponse is the response structure used on the OMAS REST API calls that return a CommunityElement object as a response.
ConnectionRequestBody	ConnectionRequestBody carries the parameters for describing a connection.
ConnectionResponse	OCFConnectionResponse is a response object for passing back a single connection object.
ConnectionsResponse	ConnectionsResponse is a response object for passing back a list of connection objects.
ConnectorReportResponse	ConnectorReportResponse is the response structure used on REST API calls that return a ConnectorType object as a response.
ConnectorTypeRequestBody	ConnectorTypeRequestBody carries the parameters for describing a connector type.
ConnectorTypeResponse	ConnectorReportResponse is a response object for passing back a single connector type object.
ConnectorTypesResponse	ConnectorTypesResponse is a response object for passing back a list of connector type objects.
ContactMethodRequestBody	ContactMethodRequestBody provides the request body payload for working on ContactMethod entities.
ControlFlowElementResponse	ControlFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
ControlFlowElementsResponse	ControlFlowElementsResponse is a response object for passing back a a list of control flow relationships or an exception if the request failed.
ControlFlowRequestBody	ControlFlowRequestBody describes the request body used when linking elements within processes.
CountResponse	CountResponse defines the response structure for the OMAS REST API calls that returns a number as a response.
DatabaseColumnResponse	DatabaseColumnResponse is a response object for passing back a single database column element or an exception if the request failed.
DatabaseColumnsResponse	DatabaseColumnsResponse is a response object for passing back a a list of database columns or an exception if the request failed.
DatabaseManagerRequestBody	DatabaseManagerRequestBody describes the basic properties of a database manager's software server capability.
DatabaseResponse	DatabaseResponse is a response object for passing back a single database element or an exception if the request failed.
DatabaseSchemaResponse	DatabaseSchemaResponse is a response object for passing back a single database schema element or an exception if the request failed.
DatabaseSchemasResponse	DatabaseSchemasResponse is a response object for passing back a a list of database schemas or an exception if the request failed.
DatabasesResponse	DatabasesResponse is a response object for passing back a a list of databases or an exception if the request failed.
DatabaseTableResponse	DatabaseTableResponse is a response object for passing back a single database table element or an exception if the request failed.
DatabaseTablesResponse	DatabaseTablesResponse is a response object for passing back a a list of database tables or an exception if the request failed.
DatabaseViewResponse	DatabaseViewResponse is a response object for passing back a single database view element or an exception if the request failed.
DatabaseViewsResponse	DatabaseViewsResponse is a response object for passing back a a list of database views or an exception if the request failed.
DataContainerRequestBody	DataContainerRequestBody describes the properties of the data container plus the optional identifiers for an owning software server capability.
DataContainerResponse	DataContainerResponse is a response object for passing back a single data container element or an exception if the request failed.
DataContainersResponse	DataContainersResponse is a response object for passing back a a list of data containers or an exception if the request failed.
DataFieldRequestBody	DataFieldRequestBody describes the properties of the data field plus the optional identifiers for an owning software server capability.
DataFieldResponse	DataFieldResponse is a response object for passing back a single data field element or an exception if the request failed.
DataFieldsResponse	DataFieldsResponse is a response object for passing back a a list of data fields or an exception if the request failed.
DataFileRequestBody	DataFileRequestBody carries the parameters for creating a new file asset.
DataFileResponse	DataFileResponse is the response structure used on the OMAS REST API calls that return the properties for a file.
DataFilesResponse	DataFilesResponse is a response object for passing back a a list of database views or an exception if the request failed.
DataFlowElementResponse	DataFlowElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
DataFlowElementsResponse	DataFlowElementsResponse is a response object for passing back a a list of data flow relationships or an exception if the request failed.
DataFlowRequestBody	DataFlowRequestBody describes the request body used when linking elements within processes.
DataFolderRequestBody	DataFileRequestBody carries the parameters for creating a new file asset.
DataManagerOMASAPIRequestBody	DataManagerOMASAPIRequestBody provides a common header for Data Manager OMAS request bodies for its REST API.
DataManagerOMASAPIResponse	FFDCResponseBase provides a common header for Data Manager OMAS managed rest to its REST API.
DataProcessingEngineRequestBody	DataProcessingEngineRequestBody describes the basic properties of a data processing engine's software server capability.
DeleteRequestBody	DeleteRequestBody provides a structure for passing the qualified name of an object to be deleted.
DeploymentRequestBody	DeploymentRequestBody provides the request body payload for working with the relationships between software server platforms and hosts.
DerivedSchemaTypeQueryTargetRequestBody	DerivedSchemaTypeQueryTargetRequestBody describes the properties of a query target plus the optional identifiers for an owning software server capability.
DigitalLocationRequestBody	DigitalLocationRequestBody carries the parameters for marking a location as a digital (cyber) location.
DigitalServiceResponse	DigitalServiceResponse is a response object for passing back a single digital service object.
DigitalServicesResponse	DigitalServicesResponse is a response object for passing back a list of digital service elements.
DuplicatesRequestBody	DuplicatesRequestBody provides a structure for passing the properties associated with duplicates.
DuplicatesResponse	DuplicatesResponse is a response object for passing back a list of duplicates.
EffectiveDatesRequestBody	ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
EffectiveTimeQueryRequestBody	EffectiveTimeQueryRequestBody carries the date/time for a query.
EffectiveTimeRequestBody	EffectiveTimeRequestBody carries the date/time for a query.
ElementHeaderResponse	ElementHeaderResponse is the response structure used on the OMAS REST API calls that return the header for a element.
ElementHeadersResponse	ElementHeadersResponse is a response object for passing back a list of element headers or an exception if the request failed.
ElementStatusRequestBody	ElementStatusRequestBody describes the status of an asset.
ElementStubResponse	ElementStubResponse is a response object for passing back the header of a Referenceable element or an exception if the request failed.
ElementStubsResponse	ElementStubsResponse is the response structure used on the OMAS REST API calls that return a list of element identifiers as a response.
EmbeddedConnectionRequestBody	The EmbeddedConnection is used within a VirtualConnection to link to the embedded connections.
EndpointRequestBody	EndpointRequestBody carries the parameters for describing an endpoint.
EndpointResponse	EndpointResponse is a response object for passing back a single endpoint object.
EndpointsResponse	EndpointsResponse is a response object for passing back a list of endpoint objects.
EnumSchemaTypeRequestBody	EnumSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.
EventBrokerRequestBody	EventBrokerRequestBody describes the basic properties of a event broker's software server capability.
EventTypeRequestBody	EventTypeRequestBody describes the properties of the event type plus the optional identifiers for an owning software server capability.
EventTypeResponse	EventTypeResponse is a response object for passing back a single EventType element or an exception if the request failed.
EventTypesResponse	EventTypesResponse is a response object for passing back a a list of EventTypes or an exception if the request failed.
ExternalReferenceIdRequestBody	ExternalReferenceIdRequestBody provides a structure for the unique external reference identifier.
ExternalReferenceLinkRequestBody	ExternalReferenceRequestBody describes the properties of the external reference plus the optional identifiers for an owning element.
ExternalReferenceRequestBody	ExternalReferenceRequestBody provides a structure for a new ExternalReference.
ExternalReferenceResponse	ExternalReferenceResponse is the response structure used on the OMAS REST API calls that returns a external reference object as a response.
ExternalReferencesResponse	ExternalReferencesResponse is the response structure used on the OMAS REST API calls that return a list of external references as a response.
ExternalSourceRequestBody	ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
FeedbackRequestBody	FeedbackRequestBody provides a base class for passing feedback objects as a request body over a REST API.
FFDCResponse	FFDCResponse is the top-level class for a response object used to return results on REST APIs.
FFDCResponseBase	FFDCResponseBase provides the base class for REST API responses.
FFDCRESTClient	RESTClient is responsible for issuing calls to the OMAS REST APIs.
FFDCRESTClientBase	RESTClient is responsible for issuing calls to the OMAS REST APIs.
FileFolderResponse	FileFolderResponse is the response structure used on the OMAS REST API calls that return the properties for a folder.
FileFoldersResponse	FileFoldersResponse is a response object for passing back a a list of database views or an exception if the request failed.
FileManagerRequestBody	FileManagerProperties describes the root node of a file system.
FileSystemRequestBody	FileSystemProperties describes the root node of a file system.
FileSystemResponse	FileSystemResponse is the response structure used on the OMAS REST API calls that return the properties for a file system.
FilterRequestBody	FilterRequestBody is the request body structure used on OMAG REST API calls that passed a string that is used to filter responses.
FixedLocationRequestBody	FixedLocationRequestBody carries the parameters for marking a location as a fixed physical location.
FormRequestBody	FormRequestBody describes the properties of the form plus the optional identifiers for an owning software server capability.
FormResponse	FormResponse is a response object for passing back a single form element or an exception if the request failed.
FormsResponse	FormsResponse is a response object for passing back a a list of forms or an exception if the request failed.
FormulaRequestBody	FormulaRequestBody carries the parameters for creating a new CalculatedValue classification.
GovernanceDefinitionGraphResponse	GovernanceDefinitionGraphResponse is the response structure used on the OMAS REST API calls that returns a governance definition graph object as a response.
GovernanceDefinitionRequestBody	GovernanceDefinitionRequestBody provides a structure used when creating governance definitions.
GovernanceDefinitionResponse	GovernanceDefinitionResponse is the response structure used on the OMAS REST API calls that returns a governance definition object as a response.
GovernanceDefinitionsResponse	GovernanceDefinitionsResponse is the response structure used on the OMAS REST API calls that return a list of governance definitions as a response.
GovernanceDomainResponse	GovernanceDomainResponse is the response structure used on the OMAS REST API calls that returns a governance domain definition object as a response.
GovernanceDomainSetResponse	GovernanceDomainResponse is the response structure used on the OMAS REST API calls that returns a governance domain definition object as a response.
GovernanceDomainSetsResponse	GovernanceDomainSetsResponse is the response structure used on the OMAS REST API calls that return a list of governance domain definition sets as a response.
GovernanceDomainsResponse	GovernanceDomainsResponse is the response structure used on the OMAS REST API calls that return a list of governance domain definitions as a response.
GovernanceLevelIdentifierResponse	GovernanceLevelIdentifierSetResponse is the response structure used on the OMAS REST API calls that returns a governance classification level identifier object as a response.
GovernanceLevelIdentifierSetResponse	GovernanceLevelIdentifierSetResponse is the response structure used on the OMAS REST API calls that returns a governance classification level identifier set object as a response.
GovernanceLevelIdentifierSetsResponse	GovernanceLevelIdentifierSetsResponse is the response structure used on the OMAS REST API calls that return a list of governance classification level identifier sets as a response.
GovernanceLevelIdentifiersResponse	GovernanceLevelIdentifiersResponse is the response structure used on the OMAS REST API calls that return a list of governance classification level identifiers as a response.
GovernanceMetricImplementationsResponse	GovernanceMetricsResponse is the response structure used on the OMAS REST API calls that return a list of governance metrics along with details of the data sets where measurements are kept as a response.
GovernanceMetricResponse	GovernanceMetricResponse is the response structure used on the OMAS REST API calls that returns a governance metric object as a response.
GovernanceMetricsResponse	GovernanceMetricsResponse is the response structure used on the OMAS REST API calls that return a list of governance metric as a response.
GovernanceRoleAppointeesResponse	GovernanceRoleAppointeesResponse is the response structure used on the OMAS REST API calls that return a list of governance roles and their appointees as a response.
GovernanceRoleHistoryResponse	GovernanceRoleHistoryResponse is the response structure used on the OMAS REST API calls that return a governance role object with details of who is and has been appointed to the role as a response.
GovernanceRoleRequestBody	GovernanceDefinitionRequestBody provides a structure used when creating governance definitions.
GovernanceRoleResponse	GovernanceRoleResponse is the response structure used on the OMAS REST API calls that returns a governance role object as a response.
GovernanceRolesResponse	GovernanceRolesResponse is the response structure used on the OMAS REST API calls that return a list of governance roles as a response.
GovernanceStatusIdentifierResponse	GovernanceStatusIdentifierSetResponse is the response structure used on the OMAS REST API calls that returns a governance classification level identifier object as a response.
GovernanceStatusIdentifierSetResponse	GovernanceStatusIdentifierSetResponse is the response structure used on the OMAS REST API calls that returns a governance classification level identifier set object as a response.
GovernanceStatusIdentifierSetsResponse	GovernanceStatusIdentifierSetsResponse is the response structure used on the OMAS REST API calls that return a list of governance classification level identifier sets as a response.
GovernanceStatusRequestBody	GovernanceDefinitionRequestBody provides a structure used when creating governance definitions.
GovernanceZoneDefinitionResponse	GovernanceZoneDefinitionResponse is the response structure used on the OMAS REST API calls that return the properties for a governance zone with the linked governance definitions.
GovernanceZoneResponse	GovernanceZoneResponse is the response structure used on the OMAS REST API calls that return the properties for a governance zone.
GovernanceZonesResponse	GovernanceZonesResponse is the response structure used on the OMAS REST API calls that return a list of governance zones.
GUIDListResponse	GUIDListResponse is the response structure used on the OMAS REST API calls that return a list of unique identifiers (guids) as a response.
GUIDResponse	GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.
HostRequestBody	HostRequestBody describes the properties of the software server for creation and update.
HostResponse	HostResponse is a response object for passing back a single host element or an exception if the request failed.
HostsResponse	HostsResponse is a response object for passing back a a list of hosts or an exception if the request failed.
InformalTagResponse	InformalTagResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a Tag object as a response.
InformalTagsResponse	InformalTagsResponse returns a list of tags from the server.
InformalTagUpdateRequestBody	InformalTagProperties stores information about a tag connected to an asset.
ITProfileRequestBody	ITProfileRequestBody provides the request body payload for working on ActorProfile entities.
ITProfileResponse	ITProfileResponse is the response structure used on the OMAS REST API calls that return a ActorProfileElement object as a response.
ITProfilesResponse	ITProfilesResponse is the response structure used on the OMAS REST API calls that return a a list of profile elements.
LicenseIdRequestBody	LicenseIdRequestBody provides a structure for the unique certificate identifier.
LicensesResponse	LicensesResponse is the response structure used on the OMAS REST API calls that return a list of licenses as a response.
LicenseTypeRequestBody	LicenseTypeRequestBody provides a structure used when creating license types.
LicenseTypeResponse	LicenseTypeResponse is the response structure used on the OMAS REST API calls that returns a license type object as a response.
LicenseTypesResponse	LicenseTypesResponse is the response structure used on the OMAS REST API calls that return a list of license types as a response.
LineageMappingElementResponse	LineageMappingElementResponse is the response structure used on the OMAS REST API calls that return the properties for a relationship.
LineageMappingElementsResponse	LineageMappingElementsResponse is a response object for passing back a a list of lineage mapping relationships or an exception if the request failed.
LineageMappingRequestBody	LineageMappingRequestBody describes the request body used when adding a lineage mapping.
LinkedExternalReferenceRequestBody
LiteralSchemaTypeRequestBody	LiteralSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.
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.
LogRecordRequestBody	LogRecordRequestBody provides a structure for passing a log record as a request body over a REST API.
MapSchemaTypeRequestBody	MapSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.
MeaningResponse	MeaningResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a Glossary Term object as a response.
MeaningsResponse	MeaningsResponse returns a list of meanings from the server.
MetadataElementSummariesResponse	MetadataElementSummariesResponse is the response structure used on the OMAS REST API calls that return a list of element identifiers as a response.
MetadataElementSummaryResponse	MetadataElementSummaryResponse is a response object for passing back a single element or an exception if the request failed.
MetadataRelationshipSummariesResponse	MetadataRelationshipSummariesResponse is the response structure used on the OMAS REST API calls that return a list of relationships identifiers as a response.
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.
NameListResponse	NameListResponse is the response structure used on the OMAS REST API calls that return a list of names as a response.
NameRequestBody	NameRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve an element by name.
NewCollectionRequestBody	NewCollectionRequestBody describes the properties to create a new collection.
NewCSVFileAssetRequestBody	NewCSVFileAssetRequestBody carries the parameters for creating a new CSV file asset.
NewDigitalProductRequestBody	NewDigitalProductRequestBody describes the properties to create a new collection with a digital product classification.
NewElementRequestBody	NewElementRequestBody provides a structure for the common properties when creating an element.
NewFileAssetRequestBody	NewFileAssetRequestBody carries the parameters for creating a new file asset.
NewFileSystemRequestBody	NewFileSystemProperties describes the root node of a file system.
NewMetadataElementRequestBody	NewMetadataElementRequestBody provides a structure for passing the properties for a new metadata element.
NewProjectRequestBody	NewProjectRequestBody describes the properties to create a new project.
NullRequestBody	NullRequestBody provides a empty request body object for POST requests that do not need to send additional parameters beyond the path variables.
OCFConnectionRequestBody	OCFConnectionRequestBody carries the parameters for created a new asset.
OCFConnectionResponse	OCFConnectionResponse is the response structure used on REST API calls that return a Connection object as a response.
OCFConnectorTypeResponse	OCFConnectorTypeResponse is the response structure used on REST API calls that return a ConnectorType object as a response.
OCFConnectorTypesResponse	OCFConnectorTypesResponse is the response structure used on the OMAS REST API calls that return a list of connector types as a response.
OriginRequestBody	OriginRequestBody provides a structure for passing information about an asset's origin as a request body over a REST API.
OwnerRequestBody	OwnerRequestBody provides a structure for passing information about an asset owner as a request body over a REST API.
PathNameRequestBody	PathNameRequestBody carries the parameters for creating a new FileFolderProperties asset.
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.
PersonalProfilesResponse	PersonalProfilesResponse is the response structure used on the OMAS REST API calls that return a list of personal profile objects.
PersonalProfileValidatorRequestBody	PersonalDetailsRequestBody provides a structure for passing personal details over a REST API.
PersonRoleAppointeesResponse	PersonRolesResponse 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.
PersonRolesResponse	PersonRolesResponse is the response structure used on the OMAS REST API calls that return a list of person role elements.
PortElementResponse	PortElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
PortElementsResponse	PortElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
PortRequestBody	PortRequestBody describes the request body used to create/update port properties.
PrimaryKeyClassificationRequestBody	PrimaryKeyClassificationRequestBody is used to classify a schema attribute as a primary key.
PrimitiveSchemaTypeRequestBody	PrimitiveSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.
ProcessCallElementResponse	ProcessCallElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
ProcessCallElementsResponse	ProcessCallElementsResponse is a response object for passing back a a list of process call relationships or an exception if the request failed.
ProcessCallRequestBody	ProcessCallRequestBody describes the request body used when linking elements within processes.
ProcessContainmentTypeRequestBody	ProcessContainmentTypeRequestBody is the request body structure used on OMAG REST API calls that passes a ProcessContainmentType enum.
ProcessElementResponse	ProcessElementResponse is the response structure used on the OMAS REST API calls that return the properties for a element.
ProcessElementsResponse	ProcessElementsResponse is a response object for passing back a a list of glossaries or an exception if the request failed.
ProcessRequestBody	ProcessRequestBody describes the request body used to create/update process properties.
ProcessStatusRequestBody	ProcessStatusRequestBody describes the request body used to update a process's status.
ProfileIdentityRequestBody	ProfileIdentityRequestBody provides the request body payload for working with ProfileIdentity relationships.
ProjectMemberResponse	ProjectMemberResponse is the response structure used on the OMAS REST API calls that return a ProjectTeamMember object as a response.
ProjectMembersResponse	ProjectMembersResponse is the response structure used on the OMAS REST API calls that return a list of project membership elements.
ProjectResponse	ProjectResponse is the response structure used on the OMAS REST API calls that return a ProjectElement object as a response.
ProjectsResponse	ProjectsResponse is the response structure used on the OMAS REST API calls that return a list of project elements.
PropertiesResponse	PropertiesResponse is the response structure used on REST API calls that return a property map object as a response.
QueriesResponse	QueriesResponse is a response object for passing back a a list of queries or an exception if the request failed.
QueryRequestBody	QueryRequestBody describes the properties of the query plus the optional identifiers for an owning software server capability.
QueryResponse	QueryResponse is a response object for passing back a single query element or an exception if the request failed.
RatingRequestBody	RatingRequestBody stores information about a rating connected to an asset.
ReferenceableRequestBody	ReferenceableRequestBody provides a structure for passing a referenceables' properties as a request body over a REST API.
ReferenceableUpdateRequestBody	ReferenceableUpdateRequestBody carries the correlation properties, readVersionIdentifier and effective time for a create (with parent), update or delete requests.
ReferenceValueAssignmentDefinitionsResponse	ReferenceValueAssignmentDefinitionsResponse is a response object for passing back a list of elements.
ReferenceValueAssignmentItemsResponse	ReferenceValueAssignmentItemsResponse is a response object for passing back a list of elements.
RegisteredOMAGService	RegisteredOMAGServicesResponse provides an object for returning information about a service that is registered with an OMAG Server Platform.
RegisteredOMAGServicesResponse	RegisteredOMAGServicesResponse provides a response object for returning information about a list of services that are registered in an OMAG Server Platform.
RelatedAssetsResponse	RelatedAssetsResponse is a response object for passing back a list of related assets with te properties from the relationship or an exception if the request failed.
RelatedElementsResponse	RelatedElementsResponse is a response object for passing back a list of relatedElement objects.
RelatedMetadataElementSummariesResponse	RelatedMetadataElementSummariesResponse is the response structure used on the OMAS REST API calls that return a list of element summaries as a response.
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.
ReportRequestBody	ReportRequestBody describes the properties of the report plus the optional identifiers for an owning software server capability.
ReportResponse	ReportResponse is a response object for passing back a single report element or an exception if the request failed.
ReportsResponse	ReportsResponse is a response object for passing back a a list of reports or an exception if the request failed.
SchemaAttributeRequestBody	SchemaAttributeRequestBody describes the properties of the schema attribute plus the optional identifiers for an owning software server capability.
SchemaAttributeResponse	SchemaAttributeResponse is a response object for passing back a single schema attribute element or an exception if the request failed.
SchemaAttributesResponse	SchemaAttributesResponse is a response object for passing back a a list of schema attributes or an exception if the request failed.
SchemaTypeChoiceRequestBody	SchemaTypeChoiceRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability and the list of guids for the schema types that represent the choices.
SchemaTypeElementResponse	SchemaTypeElementResponse is the response structure used on the OMAS REST API calls that return the properties for an element.
SchemaTypeElementsResponse	SchemaTypeElementsResponse is a response object for passing back a list of elements or an exception if the request failed.
SchemaTypeRequestBody	SchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.
SchemaTypeResponse	SchemaTypeResponse is a response object for passing back a single topic element or an exception if the request failed.
SchemaTypesResponse	SchemaTypesResponse is a response object for passing back a a list of schema types or an exception if the request failed.
SearchStringRequestBody	SearchStringRequestBody is the request body structure used on OMAG REST API calls that passes a regular expression to use as a search string.
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.
SecurityManagerRequestBody	SecurityManagerProperties describes the properties of a security manager.
SecurityTagsRequestBody	SecurityTagsRequestBody provides a structure for passing information about the security tags that should be attached to an asset or one of its fields.
ServerAssetUseRequestBody	ServerAssetUseRequestBody provides the request body payload for working with the relationships between software server capabilities and assets.
ServerAssetUseResponse	ServerAssetUseResponse is a response object for passing back a single relationship between a software server capability and an asset (or an exception if the request failed).
ServerAssetUsesResponse	ServerAssetUsesResponse returns a list of serverAssetUse relationships from the server.
SoftwareCapabilitiesResponse	SoftwareCapabilitiesResponse is a response object for passing back a a list of software server capabilities or an exception if the request failed.
SoftwareCapabilityRequestBody	SoftwareCapabilityRequestBody describes the properties of the software server capability for creation and update.
SoftwareCapabilityResponse	SoftwareCapabilityResponse is a response object for passing back a single software server capability element or an exception if the request failed.
SoftwareServerPlatformRequestBody	SoftwareServerPlatformRequestBody describes the properties of the software server platform for creation and update.
SoftwareServerPlatformResponse	SoftwareServerPlatformResponse is a response object for passing back a single software server platform element or an exception if the request failed.
SoftwareServerPlatformsResponse	SoftwareServerPlatformsResponse is a response object for passing back a a list of software server platforms or an exception if the request failed.
SoftwareServerRequestBody	SoftwareServerRequestBody describes the properties of the software server for creation and update.
SoftwareServerResponse	SoftwareServerResponse is a response object for passing back a single software server element or an exception if the request failed.
SoftwareServersResponse	SoftwareServersResponse is a response object for passing back a a list of software servers or an exception if the request failed.
StringMapResponse	StringMapResponse is the response structure used on the OMAS REST API calls that return a map of names to description as a response.
StringRequestBody	StringRequestBody is the request body structure used on OMAG REST API calls that passed a string.
StringResponse	GUIDResponse is the response structure used on the OMAS REST API calls that return a unique identifier (guid) object as a response.
StructSchemaTypeRequestBody	StructSchemaTypeRequestBody describes the properties of the schema type plus the optional identifiers for an owning software server capability.
SubjectAreaDefinitionResponse	SubjectAreaDefinitionResponse is the response structure used on the OMAS REST API calls that return the properties for a subject area with the linked governance definitions.
SubjectAreaResponse	SubjectAreaResponse is the response structure used on the OMAS REST API calls that return the properties for a subject area.
SubjectAreasResponse	SubjectAreasResponse is the response structure used on the OMAS REST API calls that return a list of subject area descriptions.
SupportedCapabilitiesResponse	SupportedCapabilitiesResponse returns a list of SoftwareServerSupportedCapability relationships from the server.
SupportedCapabilityRequestBody	SupportedCapabilityRequestBody provides the request body payload for working with the relationships between software servers and software server capabilities.
SurveyReportsResponse	SurveyReportsResponse is the response structure used on OMAS REST API calls that return a list of SurveyReport properties objects as a response.
TagUpdateRequestBody	InformalTagProperties stores information about a tag connected to an asset.
TeamPlayerRequestBody	TeamPlayerRequestBody provides the request body payload for linking roles to teams.
TemplateClassificationRequestBody	TemplateClassificationRequestBody carries the parameters for classifying an element as suitable to use for a template.
TemplateRequestBody	TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.
TermAssignmentStatusesResponse	TermAssignmentStatusesResponse is a response object for passing back a list of enum values or an exception if the request failed.
ToDoRequestBody	ToDoRequestBody provides a structure for passing to do details over a REST API.
ToDoResponse	ToDoResponse is the response structure used on the OMAS REST API calls that returns a "to do" object as a response.
ToDosResponse	ToDosResponse is the response structure used on the OMAS REST API calls that return a list of to do objects.
ToDoStatusRequestBody	ToDoStatusRequestBody provides a structure for passing the status.
ToDoStatusSearchString
TopicRequestBody	TopicRequestBody describes the properties of the topic plus the optional identifiers for an owning software server capability.
TopicResponse	TopicResponse is a response object for passing back a single topic element or an exception if the request failed.
TopicsResponse	TopicsResponse is a response object for passing back a a list of topics or an exception if the request failed.
UpdateRequestBody	UpdateRequestBody carries the correlation properties and effective time for a create, update or delete request.
UserIdentitiesResponse	UserIdentitiesResponse 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.
UseTypeRequestBody	UseTypeRequestBody for passing the use type and effective time.
ValidValueAssignmentConsumersResponse	ValidValueAssignmentConsumersResponse is a response object for passing back a list of elements.
ValidValueAssignmentDefinitionsResponse	ValidValueAssignmentDefinitionsResponse is a response object for passing back a list of elements.
ValidValueMappingsResponse	ValidValueMappingsResponse is a response object for passing back a list of valid value mappings.
ValidValueResponse	ValidValueResponse is a response object for passing back a single valid value object.
ValidValueSetsResponse	ValidValueSetsResponse is a response object for passing back a a list of valid value sets or an exception if the request failed.
ValidValuesImplAssetsResponse	ValidValuesImplAssetsResponse is a response object for passing back a list of assets (reference data sets) that use the valid value in their implementation.
ValidValuesImplDefinitionsResponse	ValidValuesImplDefinitionsResponse is a response object for passing back a list of elements.
ValidValuesMappingsResponse	ValidValuesMappingsResponse is a response object for passing back a list of valid value mappings.
ValidValuesRequestBody	ValidValuesRequestBody carries the parameters for created a new valid values element.
ValidValuesResponse	ValidValuesResponse is a response object for passing back a list of valid value objects.
VoidResponse	VoidResponse defines the response structure for the OMAS REST API calls that returns a void as a response.