Skip to main content
Version: Next

Get a model (reduced)

GET 
/models/:modelId

Find a model by its UUID. Returns a reduced model JSON, with evaluatables and diagrams given as a list of IDs.

For evaluatable and diagram retrieval, see:

Request​

Path Parameters

    modelId uuidrequired

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    UUID of model to retrieve

Responses​

OK

Schema

    $schema JSON Schema URI (string)

    URI for schema, used for validation. Likely a URL to the public source file for this schema.

    meta

    object

    required

    (DRAFT) -- Base properties shared by all DI Assets.

    uuid uuidrequired

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    Unique identifier for this asset.

    name Name (string)

    The human-readable name for this asset.

    summary Summary (string)

    Longer description of the asset.

    documentation

    object

    Full documentation for the asset/element/model.

    content stringrequired
    MIMEType stringrequired
    version Asset Version (string)

    Version number for the asset.

    draft Asset Draft Status (boolean)

    Default value: true

    Flag to mark non-functional or work-in-progress assets.

    creator uuid

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    Unique identifier for this asset's creator.

    createdDate date-time

    Datetime when this asset was created.

    updator uuid

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    Unique identifier for the user that most recently updated this asset.

    updatedDate date-time

    Datetime when this asset was most recently updated.

    evaluatables uuid[]

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    List of UUIDs identifying the evaluatable model (or set of model components) used for computing or simulating this CDM.

    diagrams uuid[]

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    List of UUIDs identifying the diagrams (likely Causal Decision Diagrams) associated with this model.

    addons

    object

    Holds addon objects for storing data not specified in OpenDI standards.

    property name*

    Addon Data

    All addon objects should be named ADDON_[name]. This naming may be enforced in future versions of OpenAPI.
    Addons must have a UUID and owner information, to mitigate addon naming collisions.

    addonMeta

    object

    required

    (DRAFT) -- Base properties shared by all DI Assets.

    uuid uuidrequired

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    Unique identifier for this asset.

    name Name (string)

    The human-readable name for this asset.

    summary Summary (string)

    Longer description of the asset.

    documentation

    object

    Full documentation for the asset/element/model.

    content stringrequired
    MIMEType stringrequired
    version Asset Version (string)

    Version number for the asset.

    draft Asset Draft Status (boolean)

    Default value: true

    Flag to mark non-functional or work-in-progress assets.

    creator uuid

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    Unique identifier for this asset's creator.

    createdDate date-time

    Datetime when this asset was created.

    updator uuid

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    Unique identifier for the user that most recently updated this asset.

    updatedDate date-time

    Datetime when this asset was most recently updated.

    owner

    object

    required

    Holds info about the owning entity for this addon. Typically a vendor or similar.

    uuid uuidrequired

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    This UUID should identify the owner across all of their addons.

    name Owner Name (string)required

    Human-readable name associated with the above owner UUID

    data

    Addon Data

    All addon data goes here. Information stored here is not standardized. Structure determined by addon owners.

    $schema Addon schema (string)

    If the addon creator has defined a JSON Schema for this addon, this field should contain the URI for that schema.

Loading...