Subject Area Open Metadata Access Service (OMAS)

The Subject Area OMAS supports subject matter experts who are documenting their knowledge about a particular subject. This includes:

The Subject Area API enables subject matter experts to author glossary content. The operations include Find, Create, Read, Update and Delete (CRUD) operations on Glossary, Term and Category objects.

These structures are defined as POJO property objects (aka beans).

The module structure for the Subject Area OMAS is as follows:

The implementation is not complete. The following has been implemented :

This has been verified by running the Subject Area samples and Subject Area FVT against an in-memory repository

Example REST calls:

Create Glossary instance

POST url: localhost:9443/servers/{serverName}/open-metadata/access-services/subject-area/users/{user}/glossaries

JSON body:

  "name": "Test glossary 1",
  "description": "This is a Glossary for testing.",
  "usage": "for test" 

Get Glossary instance

Get Glossary instance (where {serverName} is the name of the server, {guid} is the guid in the Glossary create response and {user} is the userid )

GET url: localhost:9443/servers/{serverName}/open-metadata/access-services/subject-area/users/{user}/glossaries/{guid}

(where {guid} is the GUID in the Glossary create response)

Delete Glossary instance

Delete Glossary instance (where {guid} is the guid in the Glossary create response and {user} is the userid ) DELETE url : localhost:9443/open-metadata/access-services/subject-area/users/{user}/glossaries/{guid}

The Subject Area OMAS philosophy

The Subject area OMAS is the access service that subject area experts should use. The intent is that the APIs that are exposed are natural for the tasks that a subject area expert is performing. At this time the Subject area OMAS exposes APIs around the task of Glossary authoring, focusing on Glossary, Category and Term objects.

The Subject Area OMAS architecture

The Subject Area main objects are the Glossary, Category and Terms. There map onto the OMRS types Glossary, GlossaryCategory and GlossaryTerm. The mapping is not one to one, because the OMAS API is looking to emphasise certain content and hide some of the OMRS details that the subject area expert is not concerned with.

Subject Area OMAS mapping to OMRS entities considerations:

The Subject Area OMAS API overview.

There are a number of types of APIs associated with the Subject Area OMAS.

How the Subject Area OMAS deals with effective dates

The OMRS entities, relationships and classifications have optional effective From and To dates. These dates are exposed in the Term, Category and Glossary objects as attributes.

Return to access-services module.

License: CC BY 4.0, Copyright Contributors to the ODPi Egeria project.