Metadata Connect - REST API

The database that stores the metadata is accessible via a REST API.

Purpose

The metadata is stored in a database in the Azure Cloud. Users may interact directly with it via the application interface. However, larger systems and ones requiring auditing and governance should be linked to tools that manipulate the actual items being indexed by the metadata.

The REST API provides a set of simple interfaces that can be called from within such systems, or wrappers around standard tools, such as Microsoft Office, to ensure that the database is always up to date.

REST API Categories

  • Administration - for starting and stopping Application Instances
  • Items - for creating, updating, querying and deleting Items.
  • Confidence Factors - For updating confidence factors and recalculating affected downstream values.
  • Connections - for creating, removing and querying connections.
  • Test - for testing a new application’s ability to interact with the Metadata Connect REST Server.
  • Types - For creating, querying and deleting type definitions.
  • Users - For creating, querying, updating and deleting User Items.
  • Workflows - For creating, querying, updating and deleting Workflow and Process Items.

Using The REST API

  1. Simple Test:
    • Start an Application Instance.
    • Call the Test interface.
    • Stop the Application Instance.
  2. Define The Types:
    • Create a schema(database definition).
      • Note that you can also skip this step and use the Metadata Connect application to jumpstart your project.
      • Create the Item types.
      • Create the Connection types
  3. Create the Items:

    • Create new items either via the REST API or using the CSV file loader.
    • Use the interactive interface to check the contents of a few Items.
    • Use the Item interface to obtain a list of Items.
  4. Create the Connections:
    • Use the getid call and Item Keys to fetch two Items to be connected.
    • Link them with the correct connection type.
    • Use the interactive application to check that the link has been made.
    • Repeat for all other connections.
    • Use the interactive application to look at the database
    • Use API calls to look at other connections (Ancestors and Descendants)
    • Use API calls to find paths between Items known to be connected.