How it Works

The metadata is organized by four nested entities, each contributing to a structured grouping that determines the URL for metadata retrieval. Each entity plays a unique role, allowing the API to perform CRUD (Create, Read, Update, Delete) operations on them effectively.

The Metadata Compiler Service compiles and publishes the metadata, making it accessible through a predictable URL format, as follows:

URL Structure:
https://{DOMAIN}/{NAMESPACE}/{METADATA-TYPE}/{METADATA-ID}

​

Entity Breakdown

• Domain:
  • Represents the top-level grouping, typically used for an organization or project.
  • All namespaces and metadata types associated with this project are grouped under the Domain.
• Namespace:
  • Used to define configurations within a domain, with each namespace representing a subset of the domain.
  • It serves as a categorization layer under which different metadata types can be organized, facilitating the Metadata Compiler’s processing.
• Metadata Type:
  • Categorizes metadata based on type or template, structuring how various metadata entries are stored and accessed.
  • Each metadata type is tied to a namespace and is designed to group similar metadata entries, ensuring organized access and retrieval.
• Metadata:
  • The actual data or attributes associated with individual assets, belonging to a specific metadata type.
  • This entity represents the primary information, such as asset characteristics or properties, and is accessible through the compiled URL path.