Activity

This shape has unique properties that give it a variety of appearances. See additional examples

Property	Description
`activityType`	Activity Type The type of activity.	Required
`taskType`	Task Type Adds a task icon to the block. Defaults to none.	Optional
`activityMarker1`	Activity Marker Adds an activity marker to the block. Defaults to none.	Optional
`activityMarker2`	Activity Marker Adds an activity marker to the block. Defaults to none.	Optional

BPMN Activity Block

{
    "id": "shape54",
    "type": "bpmnActivity",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Task",
    "activityType": "task",
    "taskType"  "none",
    "activityMarker1": "none",
    "activityMarker2": "none",
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Activity Type

Value
`task`
`transaction`
`eventSubProcess`
`callActivity`

Task Type

Value
`none`
`send`
`receive`
`user`
`manual`
`businessRule`
`service`
`script`

Activity Marker

Value
`none`
`subProcess`
`loop`
`parallelMI`
`sequentialMI`
`adHoc`
`compensation`

Black Box Pool

BPMN Black Box Pool Block

{
    "id": "shape55",
    "type": "bpmnBlackBoxPool",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Pool (Black Box)",
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Choreography

This shape has unique properties that give it a variety of appearances. See additional examples

Property	Description
`choreographyType`	Choreography Type The type of choreography.	Required
`participants`	Array[Participant] A list of non-initiating participants. There must be between 1 and 100 participants.	Required
`name`	String The name of the initiator.	Optional
`taskName`	String The name of the task.	Optional
`initiatingMessage`	Boolean Adds an initiating message icon to the block. Defaults to false.	Optional
`responseMessage`	Boolean Adds a response message icon to the block. Defaults to false.	Optional

BPMN Choreography Block

{
    "id": "shape56",
    "type": "bpmnChoreography",
    "boundingBox": { ... },
    "style": { ... },
    "choreographyType": "task",
    "participants": [ ... ],
    "name": "Participant A",
    "taskName": "Task",
    "initiatingMessage": false,
    "responseMessage": false,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Choreography Type

Value
`task`
`subchoreography`
`call`

Participant

Property	Description
`text`	String The text of a participant.	Required
`multipleParticipants`	Boolean Adds a multiple participants icon to the participant.	Required

{
  "text": "Participant",
  "multipleParticipants": false
}

Conversation

This shape has unique properties that give it a variety of appearances. See additional examples

Property	Description
`isCall`	Boolean Makes the block into a call block. Defaults to false.	Optional
`isSubConversation`	Boolean Makes the block into a sub-conversation block. Defaults to false.	Optional

BPMN Conversation Block

{
    "id": "shape57",
    "type": "bpmnConversation",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Conversation",
    "isCall": false,
    "isSubConversation": false,
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Data Object

This shape has unique properties that give it a variety of appearances. See additional examples

Property	Description
`dataType`	Data Type The data type of the shape. Defaults to none.	Optional

BPMN Data Object Block

{
    "id": "shape58",
    "type": "bpmnDataObject",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Data",
    "dataType": "none",
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Data Type

Value
`none`
`collection`
`input`
`output`

Data Store

BPMN Data Store Block

{
    "id": "shape59",
    "type": "bpmnDataStore",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Data Store",
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Event

This shape has unique properties that give it a variety of appearances. See additional examples

Property	Description
`eventGroup`	Event Group The event group of the shape.	Required
`eventType`	Event Type The event type of the shape. Defaults to none.	Optional
`nonInterrupting`	Boolean Determines the appearance of the shape. Defaults to false.	Optional
`throwing`	Boolean Determines the appearance of the shape. Defaults to false.	Optional

BPMN Event Block

{
    "id": "shape60",
    "type": "bpmnEvent",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Event",
    "eventGroup": "start",
    "eventType": "none",
    "nonInterrupting": false,
    "throwing": false,
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Event Group

Value
`start`
`intermediate`
`end`

Event Type

Value
`none`
`message`
`timer`
`escalation`
`conditional`
`link`
`error`
`cancel`
`compensation`
`signal`
`multiple`
`parallelMultiple`
`terminate`

Gateway

This shape has unique properties that give it a variety of appearances. See additional examples

Property	Description
`gatewayType`	Gateway Type The gateway type of the shape. Defaults to none.	Optional

BPMN Gateway Block

{
    "id": "shape61",
    "type": "bpmnGateway",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Gateway",
    "gatewayType": "none",
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Gateway Type

Value
`none`
`exclusive`
`eventBased`
`parallel`
`inclusive`
`exclusiveEventBased`
`complex`
`parallelEventBased`

Group

This shape's bounding box is incompatible with the rotation property.

Property	Description
`magnetize`	Boolean Determines whether shapes within the container move with the container. Defaults to true.	Optional

BPMN Group Block

{
    "id": "shape62",
    "type": "bpmnGroup",
    "boundingBox": { ... },
    "style": { ... },
    "magnetize": true,
    "text": "Group",
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Pool

This shape's bounding box is incompatible with the rotation property.

Property	Description
`title`	String The title text of a pool.	Required
`lanes`	Array[Pool Lane] An array of pool lanes. There must be between 1 and 50 lanes.	Required
`vertical`	Boolean Determines orientation of the pool. Defaults to true.	Optional
`verticalLaneText`	Boolean Determines orientation of the pool lane titles. Defaults to false.	Optional
`magnetize`	Boolean Determines whether shapes within the container move with the container. Defaults to true.	Optional

BPMN Pool Block

{
    "id": "shape63",
    "type": "bpmnPool",
    "boundingBox": { ... },
    "style": { ... },
    "title": "Pool",
    "lanes": [ ... ],
    "vertical": false,
    "verticalLaneText": true,
    "magnetize": true,
    "actions": [ ... ],
    "customData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}

Pool Lane

{
  "title": "Lane",
  "width": 300,
  "laneFill": "#0000"
}

Property	Description
`title`	String The title text of a pool lane.	Required
`width`	Boolean The width of a pool lane. All individual lane widths must add up to total pool width or height, depending on orientation.	Required
`laneFill`	Color Hexadecimal string representing a RGB or RGBA color value for the lane fill.	Required

Text Annotation

BPMN Text Annotation Block

{
    "id": "shape64",
    "type": "bpmnTextAnnotation",
    "boundingBox": { ... },
    "style": { ... },
    "text": "Annotation",
    "actions": [ ... ],
    "customData": [ ... ],
    "linkedData": [ ... ],
    "opacity": 100,
    "note": "Test Note"
}