centurion-erp-ui
    Preparing search index...

    Class MetaDataBase

    Base Class for API Metadata

    0.9.0

    Hierarchy (View Summary)

    Index

    Constructors

    • De-Serialize a JSON string Object to an instance of this class.

      As part of deserialization, the field key is confirmed as existing in the current, as well as if the JSON object type matches the classes declared variable of the same name. If neither match, the JSON data is ignored.

      Parameters

      • json: string

        JSON object to deserialize

      Returns MetaDataBase

    Properties

    description: String

    Description on the view.

    documentation: String

    Link to the objects documentation.

    fields: {
        [key: string]:
            | APIDataFieldRelationship
            | APIDataFieldString
            | APIDataFieldMarkdown
            | APIDataFieldJson;
    }

    Field definitions describing the APIDataObject

    Type Declaration

    layout: UILayout

    What layout the API APIDataObject will use

    name: String

    Name of the view.

    navigation?: object

    Navigation structure for the website.

    URL relevant to the current object