egeria

Open Metadata and Governance

View the Project on GitHub

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 :

Example REST calls:

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

Example REST calls:

Create Glossary instance

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

JSON body

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

body:

{
  "name": "Test glossary 1",
  "description": "This is a Glossary for testing.",
  "usage": "for test",
  "governanceActions": {
    "confidentiality": {
      "level": "Confidential",
      "confidence": "10",
      "steward": "Stuart",
      "source": "source value",
      "notes": "An interesting note",
      "status": "Proposed"
    },
    "criticality": {
      "level": "Important",
      "confidence": "9",
      "steward": "Stuart2",
      "source": "source value2",
      "notes": "An interesting note ish",
      "status": "Imported"
    },
    "confidence": {
      "level": "AdHoc",
      "confidence": "9",
      "steward": "Stuart2",
      "source": "source value2",
      "notes": "An interesting note ish",
      "status": "Imported"
    },
    "retention":{
      "confidence": 6,
      "notes": "some notes",
      "steward": "Fred",
      "source": "a source",
      "basis": "RegulatedLifetime"
    }
  }
}

Get Glossary instance

Get Glossary instance (where {user} is the guid in the Glossary create response and {user} is the userid )

GET url: localhost:8080/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 {user} is the guid in the Glossary create response and {user} is the userid ) DELETE url : localhost:8080/open-metadata/access-services/subject-area/users/{user}/glossaries/{guid}