Version: Next

Retrieve an evaluatable component

GET /evaluatables/:evaluatableId

Find an evaluatable component by its UUID. Returns the complete component JSON.

Evaluatable components are used in Models.

Request

Path Parameters

evaluatableId 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 evaluatable component to retrieve

Responses

application/json

Schema
Example (from schema)

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.

elements

object[]

required

Array [

oneOf

Evaluatable Script
API Call
Binary Base64
Custom Element

Holds a runnable script.

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.

causalType

object

required

The causal type of the decision element.

oneOf

MOD2

string

Possible values: Value must match regular expression ^CUSTOM_.*

evalType Evaluatable Typerequired

The type of evaluatable object. Determines what other properties the schema expects.

content

object

Holds properties specific to scripts.

script stringrequired

language required

Possible values: [lang1, lang2, lang3]

defaultValue Default Evaluation Valuerequired

The value that this element evaluates to by default.

Payload info for an API call, called during simulation

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.

causalType

object

required

The causal type of the decision element.

oneOf

MOD2

string

Possible values: Value must match regular expression ^CUSTOM_.*

evalType Evaluatable Typerequired

The type of evaluatable object. Determines what other properties the schema expects.

content

object

Holds properties specific to API Calls.

uriEndpoint stringrequired

payload objectrequired

defaultValue Default Evaluation Valuerequired

The value that this element evaluates to by default.

Binary object encoded in Base64

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.

causalType

object

required

The causal type of the decision element.

oneOf

MOD2

string

Possible values: Value must match regular expression ^CUSTOM_.*

evalType Evaluatable Typerequired

The type of evaluatable object. Determines what other properties the schema expects.

content

object

Holds properties specific to API Calls.

base64String stringrequired

defaultValue Default Evaluation Valuerequired

The value that this element evaluates to by default.

Holds data for a custom evaluatable element in a CDM. Data stored in this type of element is not standardized.

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.

causalType

object

required

The causal type of the decision element.

oneOf

MOD2

string

Possible values: Value must match regular expression ^CUSTOM_.*

evalType Evaluatable Type (string)required

Possible values: Value must match regular expression ^CUSTOM_.*

The type of evaluatable object. Determines what other properties the schema expects.

content Custom Element Contents

Holds properties for this custom element. Data stored here is not standardized.

defaultValue Default Evaluation Valuerequired

The value that this element evaluates to by default.

]

addons

object

Object containing data for various addons.

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.

{
  "meta": {
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "summary": "string",
    "documentation": {
      "content": "string",
      "MIMEType": "string"
    },
    "version": "string",
    "draft": true,
    "creator": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "createdDate": "2024-07-29T15:51:28.071Z",
    "updator": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "updatedDate": "2024-07-29T15:51:28.071Z"
  },
  "elements": [
    {},
    {},
    {},
    {}
  ],
  "addons": {}
}

Retrieve an evaluatable component

/evaluatables/:evaluatableId

Request​

Path Parameters

Responses​

Request

Responses