Retrieve a diagram component

GET 
/diagrams/:diagramId

Find a diagram component by its UUID. Returns the complete component JSON.

Diagram components are used in Models.

Request

Path Parameters

diagramId 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 diagram component to retrieve

Responses

200

OK

application/json

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[]

Array [

oneOf

Diagram Point

Holds a position/point in a CDD.

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_.*

diaType Diagram Typerequired

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

content

object

required

Holds properties specific to a Point.

position

object

required

x numberrequired

Default value: 0

y numberrequired

Default value: 0

associatedEvalElements 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 evaluatable elements associated with this diagram element.

Diagram Line

Holds data for a line element in a CDD.

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_.*

diaType Diagram Typerequired

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

content

object

required

Holds properties specific to a Text Element

vertices

undefined[]

required

Array [

x number

Default value: 0

y number

Default value: 0

]

associatedEvalElements 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 evaluatable elements associated with this diagram element.

Diagram Box

Holds data for a box in a CDD.

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_.*

diaType Diagram Typerequired

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

content

object

required

Holds properties specific to a Box

position

object

required

x numberrequired

Default value: 0

y numberrequired

Default value: 0

boundingBoxSize

object

required

width numberrequired

Default value: 100

height numberrequired

Default value: 100

associatedEvalElements 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 evaluatable elements associated with this diagram element.

Diagram Ellipse

Holds data for an ellipse in a CDD.

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_.*

diaType Diagram Typerequired

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

content

object

required

Holds properties specific to an Ellipse

position

object

required

x numberrequired

Default value: 0

y numberrequired

Default value: 0

xRadius numberrequired

Default value: 10

yRadius numberrequired

Default value: 10

associatedEvalElements 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 evaluatable elements associated with this diagram element.

Diagram Text

Holds data for a text element in a CDD.

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_.*

diaType Diagram Typerequired

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

content

object

required

Holds properties specific to a Text Element

position

object

required

x numberrequired

Default value: 0

y numberrequired

Default value: 0

boundingBoxSize

object

width numberrequired

Default value: 100

height numberrequired

Default value: 100

text stringrequired

font

associatedEvalElements 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 evaluatable elements associated with this diagram element.

Custom Element

Holds data for a custom graphical element in a CDD. 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_.*

diaType Diagram Type (string)required

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

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

content Custom Diagram Element Contentsrequired

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

associatedEvalElements 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 evaluatable elements associated with this diagram element.

]

dependencies

Causal Dependency[]

Array [

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.

source 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 the source element.

target 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 the target element.

]

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.

Example (from 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": [
    {},
    {},
    {},
    {},
    {},
    {}
  ],
  "dependencies": [
    {
      "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"
      },
      "source": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "target": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "addons": {}
}

Loading...