Data Record (DR) Metadata

Metadata, in MDM, is generally related (but not limited) to notifications about inbound data in a federated data domain and relates to adaptors and Master Data Records (MDRs).

Note: These notifications are different from the notification messages that are sent between adaptors through the message bus to keep them in sync.

The YOUnite notification service and related resources notify interested parties about events in the MDM system. For example, if an API client is registered for notifications on student record, when a student record is updated the API client is sent a notification message that informs them of the updated record.

For example a client interested in receiving metadata (e.g. zones, domains) notifications would POST a registration request to:

api//notifications/registration/metadata

with request body:

{
 "callbackUrl":"http://localhost:8399/domainAndZone",
 "metadataActions": [
   {"entityType": "Domain",
       "actions":["POST", "DELETE", "PUT"]},
   {"entityType": "Zone",
       "actions":["POST", "PUT"]}
  ],
 "filter": ""
}

As YOUnite Data Hub events occur, notification messages are produced and sent to zone users (consumers). The consumer specifies a callback URL (WebHook) that the YOUnite Data Hub uses to POST notification messages to.

There are two types of notification messages:

Metadata notifications: to notify the consumer of changes in metadata, for example Zone, Domain.
Data Record (DR) notifications: to notify the consumer of changes in DRs, for example, as a DR is created or updated.

In addition to specifying interest in specific metadata and data notifications, registering a notification includes:

A callback URL
An optional notification token (NTOKEN). All notifications will include this token in the NTOKEN header so the callback can verify the notification origin.

Note that the consumer in case of callback delivery:

Is acting as a server and is expected to embed/implement a web server
Handles POST requests at the location specified by the callback URL
Can inspect the notification token in the NTOKEN header
Receives a YOUniteNotification object in the request body
Should return a 2xx HTTP response

Types of Metadata

Metadata includes settings for the following:

Forbid


"forbid" adaptor	Don't GET or accept any updates from an adaptor
"forbid" zone	Don't GET or accept any updates from a zone