Skip to content

Diagram Schema ​

txt
EMRALD_Model#/definitions/Diagram
AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknown statusNoForbiddenForbiddennoneEMRALD_JsonSchemaV3_4.json*

Diagram Type ​

object (Diagram)

Diagram Properties ​

PropertyTypeRequiredNullableDefined by
idstringOptionalcannot be nullEMRALD_Model
objTypeNot specifiedRequiredcannot be nullEMRALD_Model
namestringRequiredcannot be nullEMRALD_Model
descstringRequiredcannot be nullEMRALD_Model
diagramTypestringRequiredcannot be nullEMRALD_Model
diagramTemplatestringOptionalcannot be nullEMRALD_Model
diagramLabelstringRequiredcannot be nullEMRALD_Model
statesarrayRequiredcannot be nullEMRALD_Model
changeLogarrayOptionalcannot be nullEMRALD_Model
requiredbooleanOptionalcannot be nullEMRALD_Model

id ​

Optional. Only used for internal processing needs.

id

  • is optional

  • Type: string

  • cannot be null

  • defined in: EMRALD_Model

id Type ​

string

objType ​

objType

  • is required

  • Type: unknown

  • cannot be null

  • defined in: EMRALD_Model

objType Type ​

unknown

objType Constraints ​

constant: the value of this property must be equal to:

json
"Diagram"

name ​

Name of the diagram

name

  • is required

  • Type: string

  • cannot be null

  • defined in: EMRALD_Model

name Type ​

string

desc ​

description of the diagram

desc

  • is required

  • Type: string

  • cannot be null

  • defined in: EMRALD_Model

desc Type ​

string

diagramType ​

Type of the diagram. dtSingle - means you can only be in one state of the diagram at a time and states evaluate to a value. dtMulti - means you can be in multiple states at a time, but cant evaluate the diagram

diagramType

  • is required

  • Type: string

  • cannot be null

  • defined in: EMRALD_Model

diagramType Type ​

string

diagramType Constraints ​

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"dtSingle"
"dtMulti"

diagramTemplate ​

name of template used to make this diagram

diagramTemplate

  • is optional

  • Type: string

  • cannot be null

  • defined in: EMRALD_Model

diagramTemplate Type ​

string

diagramLabel ​

Name of grouping in the UI for this diagram

diagramLabel

  • is required

  • Type: string

  • cannot be null

  • defined in: EMRALD_Model

diagramLabel Type ​

string

states ​

Names of the states used in this diagram

states

  • is required

  • Type: string[]

  • cannot be null

  • defined in: EMRALD_Model

states Type ​

string[]

changeLog ​

Type of the diagram.

changeLog

changeLog Type ​

object[] (ChangeLogItems)

required ​

If this is a template then it indicates the item must exist in the current model before using the template.

required

  • is optional

  • Type: boolean

  • cannot be null

  • defined in: EMRALD_Model

required Type ​

boolean