Schema Definitions for the Metacenter Public API.
Specifies the Criteria for retrieving object metadata. Both values and relationships on a selection of objects can
be retrieved by specifying the appropriate criteria.
Specifies a List of Object Identifiers whose metadata is to be retrieved. This is used in conjunction with the Object Selector.
Specifies any Global attribute criteria when attribute loading is enabled
Specifies any Global relationship criteria when relationship loading is enabled
Specifies any per type attribute criteria when attribute loading is enabled
Specifies any per type relationship criteria when relationship loading is enabled
Specified any formatting criteria (in addition to that implied by the Attribute Types themselves)
How is the Object List specified for retrieving metadata?
Should we load attribute metadata? If true, then Attribute Criteria may be specified to limit the number
of Attributes returned, otherwise all attribute metadata will be returned. If false, no attribute metadata is returned.
Should we load SQL attribute results? If true, the query in SQL attribute will be executed and query results
will be returned as metadata value. If false, query will not be executed and no metadata is returned.
Should we load "relationship" metadata? If true, then Relationship Attribute Criteria may be specified to limit the number
of relationships returned, otherwise all relationship metadata will be returned. If false, no relationship metadata is returned.
Should we load attribute metadata on the Related objects themselves? If true, then attribute metadata on the related objects will also be populated (conforming to the attribute criteria, if specified)
A search Criteria for retrieving objects from Metacenter. Specifies the Search Query, scope of the Search
and Paging information.
A representation of the Results from a Search Query which consists of a list of Search Objects
A criteria for retrieving Object Types
A list of Object Types
A criteria for retrieving Applications based on their Application Ids
A list of Applications
A list of PickLists
A list of Relationship Types
A Criteria for retrieving Environments
Environments for the given Application will be returned
A list of Environments
An Object that is an instance of a given Object Type within a given Application and Environment.
An object contains attribute and relationship metadata.
Within a given Metacenter instance an Object is uniquely identified by a combination of its Environment, Object Type
and Keys
For convenience, an object is identified within a given Metacenter instance by a uid which is available in the Seach index, or
it may be identified by the database physical Id, or by a Logical Id.
A sequence of keys (1 to 10) for partial object identification
Encapsulates all the attribute metadata for the object
Encapsulates all the relationship metadata for the object
A representation of the Metadata Values(s) for a given Attribute
The Attrbute to which this Metadata applies
A representation of a single Metadata Value
The value is always a "string" whose actual type is defined by the Attribute Type of the Attribute that holds the metadata
The Default Value for the Metadata. Specified on the Attribute as well, but repeated here for convenience
The value of the metadata before formatting
Variable expression from which the value was derived.
For "Linked Data List" attributes, the object Id of the related object
For "Linked Data List" attributes, the Environment Id of the related object
Represents the Relationship Metadata on a given RelationshipAttribute.
An instance of a Related Object
The Relationship Attribute to which this Relationship Metadata applies
Wraps a Related Object adding additional context information such as Relationship Type and Description
The Wrapped Related Object.
An Object Type that Object Instances conform to. A given Object Type falls under a single Application
An Object Type has Attributes. An Attribute has an AttributeType and (in the context of an object) may hold "simple" values
or related objects.
A "generalized" name for an Object Type (such as "Column" or "Table" for easy Searches)
Is this a "Container" type? i.e. mainly introduced to organize the Object Type hierarchy
Instances of these Container types are created automatically by Metacenter
The Application that this Object Type belongs to
This is a representation of the "Parent-Child" relationship between a Parent Type and its Child Types
A Reference to the Child Type
Are objects of the child Type only shortcuts to their real location.
The definition of an Attribute. An Attribute belongs to a single Object Type
An attribute can be a "value" attribute (String Long, Date Long, Data List etc.)
or it can be a Relationship attribute (which relates to other objects)
The "generalized" name of an Attribute suitable for Searches (such as table_name, data_type etc.)
The "Sql Definition" for a a Sql attribute
Constraint specification for a "Linked Data List" Attribute
If this is a Relationship Attribute,specifies the Relation Type Id of how the objects are related
The Object Type to which this Attribute belongs
The Attribute Type of this Attribute (such as String Long, Date Short etc.)
The Attribute Types supported by Metacenter (String Long, Pick List, Number etc.)
This is a higher level construct than a "simple" type such as "string" or "date"
The "simple" type underlying the Metacenter Attribute Type (such as "string", "date" etc.)
A Relationship Type describing the semantics of how objects are related
Relationship Types come in pairs. This attribute specifies the inverse of this Relationship Type, i.e the Relationship Type in the opposite direction
Corresponds to a Metacenter Active Linx
Objects Types in this Application (need not include all Object Types in this Application -- depends on the Context)
A list of the environments within this Application (need not contain all the Environments -- depends on the Context)
Corresponds to a Metacenter Repository
The Object Instance for this Environment (because environments are ALSO objects)
The Application that this Environment is an instance of
Specifies a Scope within which to look for Objects.
The top level scope is an Application. Within an application, types and environments may be specified
Specifies a SortBy to sort search results
Specifies sort criteria.
Possible sort by options
A representation of the results of performing a Search against the Metacenter Search index
Representation of the "metadata" stored in the Search index.
These are associated with semantic alias names (such as table_name, data_type etc.)
A list of Type Ids. Typically used when retrieving Type information
A per type Attribute Selection criteria. Used when retrieving Object metadata and fine-grained per type Attribute filtering is required
Specifies any attribute criteria when attribute loading is enabled
A per type Relationship Selection criteria. Used when retrieving Object metadata and fine-grained per type Relationship filtering is required
Specifies any relationship criteria when relationship loading is enabled
A criteria for specifying which object to retrieve information for.
An object may be identified by it's uid, physical id, or logical id
To retrieve only a specific list of Relationships, specify the Criteria here
You can specify (optionally) a Relationship Attribute Id which will load
all the relationships on that attribute.
Additionally, you may specify a filter by Relationship Type Id or Flow Type Id
To retrieve only a specific list of attributes in a Metadata request, specify the Attribute Ids here
By default, all attributes (i.e. the one ones holding values, not relationships) will be loaded
Any formatting criteria for the metadata in addition to what is implied in the Attribute Types.
Should the Html be stripped out from the metadata values?