MVFv3 API Documentation
    Preparing search index...

    Details provides a standard way to add common pieces of additional information to an object. Typically all properties are optional, though some schemas may define details where certain properties are required. See WithRequiredDetails.

    type Details = {
        description?: string;
        externalId?: string;
        name?: string;
        shortName?: string;
        icon?: string;
    }
    Index

    Properties

    description?: string

    A description of the entity.

    externalId?: string

    An identifier that can be used to link this entity to data outside of the MVF.

    name?: string

    The name of the entity.

    shortName?: string

    A short name for the entity. Usually a handful characters (eg; R303, F1, L, etc.) For display in places a full name would be too long or cumbersome.

    icon?: string

    A URL to an icon for the entity.