{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/cpm/developer/services/graphic/request_json/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

Request JSON

\n

The Request JSON is used for the CalculateLayout endpoint of the Symbio-Graphic-Service. Layout calculation can be requested for

\n\n

From now on the description refers to the calculation type flow.

\n

Table of contents

\n\n

1. - General structure of the Request JSON

\n

The Request JSON (for calculation type flow) must provide all necessary information to calculate a layout (and optionally render a graphic, in the case the result type is esvg, svg, sesvg or ssvg) of a process flow (directed graph with any number of nodes and edges).

\n

Disclaimer: The following comparison between the Request JSON and BPMN is made not because the two formats perform a similar task, but because they convey similar content: Process flows.

\n\n\n\n\n\n\n\n
The file structureCompared to BPMNComments
\n▶\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"result\": \"json\",\n  \"calculation\": \"flow\",\n  \"configurations\": [\n    ...\n  ],
\n
\n

▶

\n
\n
\n
Copy
\n
Copied
\n
\n 
  \"context\": {\n    ...\n  },
\n
\n

▶

\n
\n
\n
Copy
\n
Copied
\n
\n 
  \"content\": {\n    \"nodes\": [\n      {\n        ...\n      },\n      ...\n    ],\n    \"edges\": [\n      {\n        ...\n      },\n      ...\n    ]\n  },
\n
\n

▶

\n
\n
\n
Copy
\n
Copied
\n
\n 
  \"pools\": [\n    ...\n  ],
\n
\n

▶

\n
\n
\n
Copy
\n
Copied
\n
\n 
  \"elements\": [\n    ...\n  ]\n}
\n
\n		\n▶\n
\n
`, `15778411552098804000`)\"\n >\n
Copy
\n
Copied
\n
\n 
<definitions>
\n
\n

▶\n

\n
\n
\n ...\n ...`, `62711110615452980000`)\"\n >\n
Copy
\n
Copied
\n
\n 
  <bpmndi:BPMNDiagram>\n    ...\n    ...
\n
\n

▶

\n
\n
\n\n \n ...\n \n ...\n\n\n \n ...\n \n ...\n\n \n `, `12552614919865833000`)\"\n >\n
Copy
\n
Copied
\n
\n 
    <bpmndi:BPMNPlane>\n\n      <bpmndi:BPMNShape>\n      ...\n      </bpmndi:BPMNShape>\n      ...\n\n\n      <bpmndi:BPMNEdge>\n      ...\n      </bpmndi:BPMNEdge>\n      ...\n\n    </bpmndi:BPMNPlane>\n  </bpmndi:BPMNDiagram>
\n
\n

▶

\n
\n
\n ...\n `, `91434364520328610000`)\"\n >\n
Copy
\n
Copied
\n
\n 
  <collaboration>\n      ...\n  </collaboration>
\n
\n

▶

\n
\n
\n ...\n \n`, `88528754216218130000`)\"\n >\n
Copy
\n
Copied
\n
\n 
  <process>\n      ...\n  </process>\n</definitions>
\n
\n		\n▶ Diagram meta-information
\nThe JSON format has to support layout and rendering requests for multiple purposes (cxn and flow) as well as multiple configurations.\n
\nThus it provides some meta-information like the requested \"result\" and the type of \"calculation\" as well as details regarding layout and rendering \"configurations\".

\n▶ Diagram context
\nThe JSON format holds additional information about the diagram, that are not known to BPMN.


\n▶ Diagram content - Commonalities
\nBesides that, the Request JSON and BPMN hold directly comparable data:
\n- JSON \"nodes\" / \"edges\" and the BPMN <bpmndi:BPMNPlain> contain the collection of node-shapes and edge-shapes.
\n- JSON \"pools\" and the BPMN <collaboration> contain the collection of pools.
\n- JSON \"elements\" and the BPMN <process> contain the collection of node-definitions and edge-definitions.

\nDiagram content - Differences
\n- While JSON provides diagram information as sub-nodes (e.g.: \"id\": \"1\",), BPMN provides diagram information as attributes (e.g.: <bpmn:process id=\"1\">).
\n- While JSON distinguishes the \"nodes\" collection and the \"edges\" collection, BPMN doesn't.

\n▶ Pools
\nThe Request JSON can hold and BPMN holds a collection of pools. While the Request JSON needs the collection of pools only to add an empty pool or to determine the order of the pools, BPMN always needs the collection of pools.

\n▶ Elements
\nThe Request JSON and BPMN hold a collection elements. Each node referres to an element, multiple nodes can refer to the same element. The elements hold additional information, that can be shared across multiple nodes.

\n
\n

2.0 - The diagram meta-information part of the Request JSON

\n

2.1 - How it typically looks like

\n\n\n\n\n\n\n\n
Example with request for one layoutExample with request for six layoutsComments
\n
\n
\n
Copy
\n
Copied
\n
\n 
  \"result\": \"json\",\n  \"calculation\": \"flow\",\n  \"configurations\": [\n    {\n      \"layoutType\": \"flow\",\n      \"lcid\": 1031,\n      \"vertical\": true\n    }\n  ]\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n.
\n
\n		\n
\n
\n
Copy
\n
Copied
\n
\n 
  \"result\": \"json\",\n  \"calculation\": \"flow\",\n  \"configurations\": [\n    {\n      \"layoutType\": \"flow\",\n      \"lcid\": 1031,\n      \"vertical\": true\n    },\n    {\n      \"layoutType\": \"flow\",\n      \"lcid\": 1031,\n      \"vertical\": false\n    },\n    {\n      \"layoutType\": \"swimlane-roles\",\n      \"lcid\": 1031,\n      \"vertical\": true\n    },\n    {\n      \"layoutType\": \"swimlane-roles\",\n      \"lcid\": 1031,\n      \"vertical\": false\n    },\n    {\n      \"layoutType\": \"swimlane-apps\",\n      \"lcid\": 1031,\n      \"vertical\": true\n    },\n    {\n      \"layoutType\": \"swimlane-apps\",\n      \"lcid\": 1031,\n      \"vertical\": false\n    }\n  ]
\n
\n		\n

The the three available \"layoutType\"s

\n
    \n
  • \"flow\" (layout without lanes or pools)
    • \n
  • \"swimlane-roles\" (layout with lanes and pools based on roles, alternatively based on organizational units) and
    • \n
  • \"swimlane-apps\" (layout with lanes and pools based on application systems, alternatively based on roles)
    • \n
\ncan be combined with the two \"vertical\" direction values\n
    \n
  • true (vertical flow, typical for EPC) and
    • \n
  • false (horizontal flow, typical for BPMN)
    • \n
\nand this generates six possible layouts.

\nIn addition to that the \"lcid\" defines the language, that is used in case not only a layout but also a rendering (the \"result\" type is \"esvg\", \"svg\", \"sesvg\" or \"ssvg\") is requested.\n
\n

2.2 - The requested result type

\n

The currently suported result types for the calculation type flow are

\n\n

2.3 - The requested calculation type

\n

The currently suported calculation types are

\n\n

The calculation type cxn supports all result types.
\nThe calculation type flow supports the result types 1. ... 4. only.

\n

2.4 - The configurations

\n

The configurations collection can currently contain one or six configuration(s).
\nOne configuration is provided, of only one of the following layouts hast to be calculated:

\n\n

All six configurations (three layoutType values multiplied with two vertical direction values) are provided, if all of the above listed layouts have to be calculated.

\n

3.0 - The context part of the Request JSON (diagram as a whole)

\n

The context represents the diagram (process) to layout as a whole. BPMN contains this data within the <bpmndi:BPMNDiagram> tag.

\n

3.1 - How it typically looks like

\n
\n
\n
Copy
\n
Copied
\n
\n 
  \"context\": {\n    \"id\": \"3783f2a0-99c0-4120-a639-4acfd59a8021\",\n    \"properties\": {\n      \"elementTypeKind\": \"business\",\n      \"facetName\": \"processes\",\n      \"state\": \"inProcess\",\n      \"stereoType\": \"f5942ab4-2365-4a07-8a3f-04d10fb3b870\",\n      \"type\": \"subProcess\",\n      \"versionId\": \"2a536296-d3c7-47cf-8d2e-511eaf5b666d\"\n    },\n    \"attributes\": [\n      {\n        \"key\": \"links\",\n        \"type\": \"linksValue\",\n        \"values\": [\n          {\n            \"lcid\": 127,\n            \"value\": {\n              \"links\": [\n                {\n                  \"locator\": \"www.duckduckgo.com\",\n                  \"title\": \"Find\"\n                }\n              ]\n            }\n          }\n        ]\n      },\n      {\n        \"key\": \"majorVersion\",\n        \"type\": \"integer\",\n        \"values\": [\n          {\n            \"lcid\": 127,\n            \"value\": 0\n          }\n        ]\n      },\n      {\n        \"key\": \"minorVersion\",\n        \"type\": \"integer\",\n        \"values\": [\n          {\n            \"lcid\": 127,\n            \"value\": 1\n          }\n        ]\n      },\n      {\n        \"key\": \"name\",\n        \"type\": \"multiLineText\",\n        \"values\": [\n          {\n            \"lcid\": 1031,\n            \"value\": \"GRAPHIC-API\"\n          }\n        ]\n      }\n    ]\n  }
\n
\n

3.2 - Context informations

\n

Typical information provided for the diagran (process) are:

\n\n

4.0 - The content part of the Request JSON (containing the nodes and edges collections)

\n

The content contains the nodes and edges (in the meaning of nodes and edges within a directed graph) of the diagram (process). Typically the nodes and edges are displayed as soon als the layout is rendered. Therefore the nodes require the calculation of their positions and the edges require the calculation of their routes in order to be written to the Result JSON including the positions and routes.

\n

4.1 - How it typically looks like

\n
\n
\n
Copy
\n
Copied
\n
\n 
  \"content\": {\n    \"nodes\": [\n      {\n        \"shapeId\": \"e85e124a-86aa-4fe6-aaaf-4c5707215461\",\n        \"elementId\": \"5dd9be26-b592-4e02-b4b0-e508a7844e27\",\n        \"properties\": {\n          \"type\": \"evStart\"\n        },\n        \"laneRelevantRelated\": [\n          {\n            \"elementId\": \"c61aaf77-5d75-4ff6-a567-d9662715c46d\",\n            \"layoutTypes\": [\n              \"swimlane-roles\",\n              \"swimlane-apps\"\n            ]\n          }\n        ]\n      },\n      ...\n    ],\n    \"edges\": [\n      {\n        \"shapeId\": \"ad711e08-3fd4-44b6-bac8-518e72a005c2\",\n        \"elementId\": \"3bf7c2cf-a70e-49d3-9377-301bfebec515\",\n        \"properties\": {\n          \"type\": \"crt1\",\n          \"source\": {\n            \"shapeId\": \"542e5c76-5482-4b4d-bf56-8a6d927e6a6b\"\n          },\n          \"target\": {\n            \"shapeId\": \"343b15d4-3d51-4b1b-9bef-4b3b4889a88f\"\n          }\n        }\n      },\n      ...\n    ],
\n
\n

(see chapter 7.0 Understanding the correlation of nodes / edges and elements by examples below).

\n

4.2 - The nodes collection

\n

Nodes represent the shapes, comparable to BPMN <startEvent> or <task>.

\n
\n
\n
Copy
\n
Copied
\n
\n 
      {\n        \"shapeId\": \"e85e124a-86aa-4fe6-aaaf-4c5707215461\",\n        \"elementId\": \"5dd9be26-b592-4e02-b4b0-e508a7844e27\",\n        \"properties\": {\n          \"pool\": {\n            \"poolId\": \"c84c7e2e-ea39-4fc8-b2dd-10df2b7c766a\"\n          },\n\t  \"type\": \"evStart\"\n        },\n        \"laneRelevantRelated\": [\n          {\n            \"elementId\": \"c61aaf77-5d75-4ff6-a567-d9662715c46d\",\n            \"layoutTypes\": [\n              \"swimlane-roles\",\n              \"swimlane-apps\"\n            ]\n          }\n        ]\n      }
\n
\n

Typical information provided for a node are:

\n\n

The pool assignment

\n

A node can optionally be assigned to a pool. The poolId must refer to an existing pool within the The pools part of the Request JSON .

\n

The laneRelevantRelated collection

\n

Since the Request JSON has to support multiple layouts at once, it is required to provide information about the lane assignment per layout. Therefore the laneRelevantRelated element collection includes for each lane relevant element the information which layoutTypes are supported by a lane relevant element. The values used for the layoutTypes here match the values used for the layoutType within the configurations.

\n

(For details regarding the layoutType values see chapter The configurations above).

\n

Putting it all together\nFor a sample, that shows the correlation between node and element in the Request JSON and in the Result JSON and also in comparison to BPMN see chapter 7.0 Understanding the correlation of nodes / edges and elements by examples and section Sample 1 (a node/shape and the underlaying element vs. the BPMN equivalent).

\n

4.3 - The edges collection

\n

Edges represent the connection between shapes, comparable to BPMN <sequenceFlow>.

\n
\n
\n
Copy
\n
Copied
\n
\n 
    {\n        \"shapeId\": \"ad711e08-3fd4-44b6-bac8-518e72a005c2\",\n        \"elementId\": \"3bf7c2cf-a70e-49d3-9377-301bfebec515\",\n        \"properties\": {\n          \"type\": \"crt1\",\n          \"source\": {\n            \"shapeId\": \"542e5c76-5482-4b4d-bf56-8a6d927e6a6b\"\n          },\n          \"target\": {\n            \"shapeId\": \"343b15d4-3d51-4b1b-9bef-4b3b4889a88f\"\n          }\n        }\n      }
\n
\n

Typical information provided for an edge are:

\n\n

5.0 - The pools part of the Request JSON

\n

Pools can be automatically recognized from the nodes collection.

\n

But either if empty pools are to be added or if pools shall be sorted in a distict order the automatic pool recognition is insufficient and the pools must be listed explicitly.

\n

So we have these cases:

\n\n

5.1 - How it typically looks like

\n

This is an example with three pools:

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"id\": \"d5d7ce44-c18f-4119-aa18-8f9e8aa69e85\",\n  \"properties\": {\n    \"type\": \"bpmnPool\",\n    \"kind\": \"object\",\n    \"servity\": \"source\"\n  },\n  \"attributes\": [{\n    \"key\": \"name\",\n    \"type\": \"multiLineText\",\n    \"values\": [\n      { \"lcid\": 1033, \"value\": \"Data source\" }\n    ]\n  }]\n},\n{\n  \"id\": \"03c092c9-b723-4a38-befd-f6f54aef42d6\",\n  \"properties\": {\n    \"type\": \"bpmnPool\",\n    \"kind\": \"object\"\n  },\n  \"attributes\": [{\n    \"key\": \"name\",\n    \"type\": \"multiLineText\",\n    \"values\": [\n      { \"lcid\": 1033, \"value\": \"Processing\" }\n    ]\n  }],\n  \"children\": [\n      \"467cbfa4-ff43-49fe-ac0d-49beda2e07f6\",\n      \"c989af38-3e9e-4693-a284-3801da7696de\"\n  ]\n},\n{\n  \"id\": \"63cf252b-ed7f-458e-97c3-3b557786eb52\",\n  \"properties\": {\n    \"type\": \"bpmnPool\",\n    \"kind\": \"object\",\n    \"servity\": \"target\"\n  },\n  \"attributes\": [{\n    \"key\": \"name\",\n    \"type\": \"multiLineText\",\n    \"values\": [\n      { \"lcid\": 1033, \"value\": \"Data target\" }\n    ]\n  }]\n},\n...
\n
\n

The \"pools\" are of item type \"bpmnPool\" and of item kind \"object\".

\n

It is highly recommended to define names for all pools (see \"attributes\" with \"key\": \"name\").

\n

5.2 - The pool servity

\n

One pool should be designated as the default pool so that shapes can be automatically (fall- back) attached to the default pool without explicitly assigning a pool to shapes. This creates a fail-safe behavior and makes the JSON code shorter. To identify the default pool you can:

\n\n

In the case that a pool should contain multiple lanes and the lanes should be in a defined order, it is recommended to define the lanes as a list of children (see \"children\"). The ids, specified in the list of children, must refer to existing items, that are typically roles, groups, application systems or application services.

\n

Nevertheless, it is possible to provide the pools without any tuning at all and let the Symbio-Graphic-Service do all the tuning.

\n

6.0 - The elements part of the Request JSON

\n

The elements collection contains all elements, that

\n\n

6.1 - How it typically looks like for events

\n\n\n\n\n\n\n\n
An event sample request JSON elementCompared to the BPMN <bpmn:process/> tagComments
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"id\":\n    \"B63F2971E571B69F49AAD5B0733302FA\",\n  \"properties\": {\n    \"type\": \"evStart\",\n    \"kind\": \"OBJ\",\n    \"evType\": \"throwSignal\"\n  },\n  \"attributes\": [\n    {\n      \"key\": \"name\",\n      \"values\": [\n        { \"lcid\": 1033,\n          \"value\": \"Start\" }\n      ]\n    },\n      ...\n  ]\n}
\n
\n		\n
\n
\n \n SequenceFlow_0pern26\n \n\n...`, `29240518818538308000`)\"\n >\n
Copy
\n
Copied
\n
\n 
<bpmn:startEvent\n id=\"StartEvent_0034tgy\"\n name=\"Goods arrived\">\n  <bpmn:outgoing>\n    SequenceFlow_0pern26\n  </bpmn:outgoing>\n</bpmn:startEvent>\n...
\n
\n		\nThe request JSON elements and the BPMN <bpmn:process/> nodes provide very similar information:
\n- The type, either \"evStart\" or <bpmn:startEvent>, and
\n- the name, either \"attributes\"/\"key\": \"name\" or name attribute.

\nBut there are also differences:
\n- While BPMN provides also the structure defining edges <bpmn:incoming> and <bpmn:outgoing>,
\n- the request JSON doesn't. This is because elements can be re-used within one request JSON and therefore a definition of incoming and outgoing edges can be ambiguous and is realized via the edges collection.\n
\n

6.2 - How it typically looks like for tasks

\n\n\n\n\n\n\n\n
A task sample request JSON elementCompared to the BPMN <bpmn:process/> tagComments
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"id\":\n    \"bcf7ab71d86145919a5a0a570fa2beed\",\n  \"properties\": {\n    \"type\": \"task\",\n    \"kind\": \"OBJ\",\n    \"typeDisplayName\": \"Task\"\n  },\n  \"attributes\": [\n    {\n      \"key\": \"name\",\n      \"values\": [\n        { \"lcid\": 1033,\n          \"value\": \"Task-01\" }\n      ]\n    },\n    ...\n  ],\n  \"related\": [\n    {\n      \"key\": \"accountableRole\",\n      \"shortKey\": \"A\",\n      \"versionIds\": [\n    \"35f4cfb5437e4f1d8fd072859648e183\"\n      ]\n    },\n    ...\n  ]\n}
\n
\n		\n
\n
\n \n SequenceFlow_0pern26\n \n \n SequenceFlow_1vdst1y\n \n\n...`, `22101641895521882000`)\"\n >\n
Copy
\n
Copied
\n
\n 
<bpmn:task\n id=\"Activity_16oto7s\"\n name=\"Process goods\">\n  <bpmn:incoming>\n    SequenceFlow_0pern26\n  </bpmn:incoming>\n  <bpmn:outgoing>\n    SequenceFlow_1vdst1y\n  </bpmn:outgoing>\n</bpmn:task>\n...
\n
\n		\nThe request JSON elements and the BPMN <bpmn:process/> nodes provide very similar information:
\n- The type, either \"task\" or <bpmn:task>, and
\n- the name, either \"attributes\"/\"key\": \"name\" or name attribute.

\nBut there are also differences:
\n- While BPMN provides also the structure defining edges <bpmn:incoming> and <bpmn:outgoing>,
\n- the request JSON doesn't. This is because elements can be re-used within one request JSON and therefore a definition of incoming and outgoing edges can be ambiguous and is realized via the edges collection.

\nOn the other hand the request JSON can connect a task to all types of repository elements via \"related\", e. g. milestones, requirements, KPIs, documents (guidelines, directives), standards, organizational units, projects, products, objectices and so on.\n
\n

6.3 - How it typically looks like for roles

\n\n\n\n\n\n\n\n\n
A role sample request JSON elementCompared to the BPMN <bpmn:process/> tagComments
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"id\":\n    \"ed6645df50804e6f9ab235121c5ea567\",\n  \"versionId\":\n    \"a2a8e8e8090f464fac78bec8b851c963\",\n  \"properties\": {\n    \"kind\": \"OBJ\",\n    \"stereoType\": \"extern\",\n    \"type\": \"role\",\n    \"typeDisplayName\": \"Role\"\n  },\n  \"attributes\": [\n    {\n      \"key\": \"name\",\n      \"values\": [\n        { \"lcid\": 1033,\n          \"value\": \"DP officer\" }\n      ]\n    },\n    ...\n  ]\n}
\n
\n		\n
\n
\n \n ...\n \n\n `, `58499017599401900000`)\"\n >\n
Copy
\n
Copied
\n
\n 
<bpmn:laneSet\n  id=\"LaneSet_1n0pzhw\">\n  <bpmn:lane\n    id=\"Lane_0w5mswf\"\n    name=\"MyLane-01\">\n    ...\n  </bpmn:lane>\n</bpmn:laneSet>\n
\n
\n		\nThere is no general BPMN equivalent for the repository elements in request JSON.

\nWhile request JSON nodes can refer to various types of repository elements via related or laneRelevantRelated, BPMN can only organize elements in swimlanes (which is equivalent to request JSON's laneRelevantRelated) and connect elements to data stores and data objects.

\nTypically roles are used to define swimlanes - that is realizes via laneRelevantRelated in request JSON and <bpmn:laneset/>/<bpmn:lane/> in BPMN.



\n
\n

6.4 - How it typically looks like for data

\n\n\n\n\n\n\n\n\n
A data sample request JSON elementsCompared to the BPMN <bpmn:process/> tagComments
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"id\":\n    \"480439511168499d8bc5a1fda3285542\",\n  \"versionId\":\n    \"1129e2af0a174064a79849002e1ceb56\",\n  \"properties\": {\n    \"kind\": \"OBJ\",\n    \"type\": \"system\",\n    \"typeDisplayName\": \"Application\"\n  },\n  \"attributes\": [\n    {\n      \"key\": \"name\",\n      \"values\": [\n        { \"lcid\": 1033,\n          \"value\": \"Accounting portal\" }\n      ]\n    },\n    ...\n  ]\n},\n{\n  \"id\":\n    \"9487278f25464394aff9e68bef9b2535\",\n  \"versionId\":\n    \"f1c69f8d04ad4e9e82f11f0465f536a6\",\n  \"properties\": {\n    \"kind\": \"OBJ\",\n    \"type\": \"inOut\",\n    \"typeDisplayName\": \"Input/Output\"\n  },\n  \"attributes\": [\n    {\n      \"key\": \"name\",\n      \"values\": [\n        { \"lcid\": 1033,\n          \"value\": \"Inbound quotation\" }\n      ]\n    },\n    ...\n  ]\n}
\n
\n		\n
\n
\n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n`, `8052753302877891000`)\"\n >\n
Copy
\n
Copied
\n
\n 
<bpmn:dataStoreReference\n  id=\n    \"DataStoreReference_07dozvu\"\n  name=\n    \"Data-Store\" />\n  \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n<bpmn:dataObjectReference\n  id=\n    \"DataObjectReference_1unf7qz\"\n  name=\n    \"Data-Object\"\n  dataObjectRef=\n    \"DataObject_1lq9toa\" />\n<bpmn:dataObject\n  id=\n    \"DataObject_1lq9toa\" />
\n
\n		\nThere is no general BPMN equivalent for the repository elements in request JSON.

\nWhile request JSON nodes can refer to various types of repository elements via related or laneRelevantRelated, BPMN can only organize elements in swimlanes (which is equivalent to request JSON's laneRelevantRelated) and connect elements to data stores and data objects.

\nTypically data stores and data objects are connected via related in request JSON and implemented as \"type\": \"system\" respectively \"type\": \"inOut\" in request JSON and implemented as <bpmn:dataStoreReference/> respectively <bpmn:dataObjectReference/> in BPMN.\n
\n\t\n### Shapes and shape items\nThe design of ***shape*** content elements is intended to be minimalistic.
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n\t\"id\": \"a6743dd3-8881-4d22-bfe7-0b7f703097c8\",\n\t\"properties\": {\n            \"itemId\": \"9bc5994a-f64f-431f-a631-1ff405f22643\",\n            \"type\": \"evStart\",\n            \"poolId\": \"6496cb0f-8763-4e27-a8dd-77870be94fd5\"\n\t}\n}
\n
\n

Referencing the shape's underlying item is done with \"itemId\" : \"9bc5994a-f64f-431f-a631-1ff405f22643\".
\nThe (optional) second reference, \"poolId\": \"6496cb0f-8763-4e27-a8dd-77870be94fd5\", defines membership of the shape in a pool.
\n

\n

Here is the shape underlying item:

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"id\": \"9bc5994a-f64f-431f-a631-1ff405f22643\",\n  \"properties\": {\n    \"type\": \"evStart\",\n    \"kind\": \"OBJ\",\n    \"evType\": \"throwSignal\"\n  },\n  \"attributes\": [{\n    \"key\": \"name\",\n    \"values\": [\n      { \"lcid\": 1033, \"value\": \"recognize hunger\" }\n    ]\n  }]\n}
\n
\n

The type is provided via the \"properties\" property array property \"type\".
\nIn addition to that the kind (which determines whether it is a shape or a edge) is provided via the \"properties\" property array property \"kind\".
\nIn case the item (and thus the shape as well) is defined more specifically, the \"properties\" property array might contain a property \"evType\" or \"funcType\" ore \"funcMarker\".
\nThe text to display is defined within the \"attributes\" property array object with the \"key\": \"name\". Since the request JSON supports multiple languages, the name value is provided by the \"values\" property array, that can hold distinct value objects for different cultures.

\n

Edges and edge items

\n

The design of edge content elements is intended to be minimalistic.
\nHere is an example:

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n\t\"id\": \"e5dfd46e-8720-408e-b760-171038da9f6d\",\n\t\"properties\": {\n\t\t\"itemId\": \"6496cb0f-8763-4e27-a8dd-77870be94fd5\",\n\t\t\"sourceId\": \"a6743dd3-8881-4d22-bfe7-0b7f703097c8\",\n\t\t\"targetId\": \"75397704-e829-49b3-a40c-02379fb0b393\",\n\t\t\"type\": \"activ1\"\n\t}\n}
\n
\n

Referencing the edge's underlying item is done with \"itemId\" : \"6496cb0f-8763-4e27-a8dd-77870be94fd5\".
\nThe is no reference to a pool, since edges can cross lanes and pools.
\nThe referencing of the source and target shapes is done with \"sourceId\": \"a6743dd3-8881-4d22-bfe7-0b7f703097c8\" and \"targetId\": \"75397704-e829-49b3-a40c-02379fb0b393\". An edge must always hold a source and a target shape reference.

\n

Here is the edge underlying item:

\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n    \"id\": \"6496cb0f-8763-4e27-a8dd-77870be94fd5\",\n    \"properties\": {\n        \"kind\": \"CXN\",\n        \"sourceId\": \"9bc5994a-f64f-431f-a631-1ff405f22643\",\n        \"targetId\": \"b0907b38-e8e4-42f3-bc0a-d3e83ae2a1a7\",\n        \"type\": \"activ1\"\n\t},\n    \"attributes\": [{\n        \"key\": \"cxnRole\",\n        \"values\": [\n        { \"lcid\": 1033, \"value\": \"yes\" }\n        ]\n    }]\n}
\n
\n

The type is provided via the \"properties\" property array property \"type\".
\nIn addition to that the kind (which determines whether it is a shape or a edge) is provided via the \"properties\" property array property \"kind\".
\nThe text to display is defined within the \"attributes\" property array object with the \"key\": \"cxnRole\". Since the request JSON supports multiple languages, the name value is provided by the \"values\" property array, that can hold distinct value objects for different cultures.

\n

Lane items

\n

In the case that the diagram is to be laid out and rendered with lanes, the lanes are automatically recognized by the fact, that they are related to structure building items via the configured laneRelevant relation (see \"laneRelevant\": \"responsible\" within configurations property). The lanes must not be of any of any specific item type (see \"type\": \"...\"), but they must be of item kind \"OBJ\" (see \"kind\": \"OBJ\") and must not be of any of the structure building item types (like \"type\": \"func\", \"type\": \"evStart\", \"type\": \"evIntermediate\", \"type\": \"evEnd\", \"type\": \"ruleXor\", \"type\": \"ruleOr\", \"type\": \"ruleAnd\" or \"type\": \"condition\").

\n

In the case that multiple lanes should be contained in a pool and the lanes should be in a defined order, it is recommended to define the lanes as a list of children (see \"children\") within the pool. The ids, specified in the list of children, must refer to existing lane (items), that are typically roles, groups, application systems or application services.

\n

Understanding the correlation of nodes / edges and elements by examples

\n

The biggest part of the necessary information is the description of the nodes and edges. In order to understand the nodes and edges within the Request JSON, comparing their data to BPMN and the expected outcome Result JSON could be helpful.

\n

Disclaimer: The following comparison between the Request JSON, BPMN and the Result JSON is made not because the two formats perform a similar task, but because they convey similar content: Process flows.

While the Request JSON contains only the necessary information for automatic layout calculation and rendering, the BPMN also already contains all information for rendering (like position and size of shapes or the interpolation points of edges), which comes closer to the Result JSON.

\n

For basics about the nodes see section The nodes collection.

\n

Sample 1 (a node/shape and the underlaying element vs. the BPMN equivalent)

\n\n\n\n\n\n\n
Request JSON sample of a shape - no position and no sizeRequest JSON sample of the underlaying element
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"shapeId\": \"fd4e1872-8742-4bfa-9c4f-b271ec81c73f\",\n  \"elementId\": \"ab99ac91-be7d-43c4-955d-04324360fbdf\",\n  \"properties\": {\n    \"type\": \"evStart\"\n  },\n  \"laneRelevantRelated\": [\n    {\n      \"elementId\": \"c61aaf77-5d75-4ff6-a567-d9662715c46d\",\n      \"layoutTypes\": [\n        \"swimlane-roles\",\n        \"swimlane-apps\"\n      ]\n    }\n  ]\n}\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n.
\n
\n		\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"id\": \"ab99ac91-be7d-43c4-955d-04324360fbdf\",\n  \"properties\": {\n    \"kind\": \"object\",\n    \"type\": \"evStart\",\n    \"typeDisplayName\": \"Start\"\n  },\n  \"attributes\": [\n    {\n      \"key\": \"description\",\n      \"type\": \"singleLineText\",\n      \"values\": [\n        {\n          \"lcid\": 1031,\n          \"value\": \"Goods arrived\"\n        }\n      ]\n    },\n    {\n      \"key\": \"evStartTrigger\",\n      \"type\": \"selectionValue\",\n      \"values\": [\n        {\n          \"lcid\": 127,\n          \"value\": \"evTriggerNoneIntSub\"\n        }\n      ]\n    },\n    {\n      \"key\": \"evType\",\n      \"type\": \"selectionValue\",\n      \"values\": [\n        {\n          \"lcid\": 127,\n          \"value\": \"evTypeMessage\"\n        }\n      ]\n    },\n    {\n      \"key\": \"name\",\n      \"type\": \"multiLineText\",\n      \"values\": [\n        {\n          \"lcid\": 1031,\n          \"value\": \"Start-01\"\n        }\n      ]\n    }\n  ],\n  \"related\": [\n    {\n      \"key\": \"executiveRole\",\n      \"shortKey\": \"R\",\n      \"versionIds\": [\n        \"9700e981-1c36-4536-a05b-592aa2fd6219\"\n      ]\n    }\n  ]\n},
\n
\n
\n\n\n\n\n\n
BPMN sample of a shape - including position and size
\n
\n
\n \n \n \n \n`, `66260456195404220000`)\"\n >\n
Copy
\n
Copied
\n
\n 
<bpmndi:BPMNShape id=\"IntermediateThrowEvent_0iyvpzm_di\" bpmnElement=\"IntermediateThrowEvent_0iyvpzm\">\n  <dc:Bounds x=\"458\" y=\"313\" width=\"36\" height=\"36\" />\n  <bpmndi:BPMNLabel>\n    <dc:Bounds x=\"464\" y=\"353\" width=\"24\" height=\"12\" />\n  </bpmndi:BPMNLabel>\n</bpmndi:BPMNShape>
\n
\n
\n\n\n\n\n\n
Result SVG a shape - including position and size (and the rendering objects: rect, path and text)
\n
\n
\n \n \n \n \n \n \n \n Goodsarrived\n`, `58062166646446236000`)\"\n >\n
Copy
\n
Copied
\n
\n 
<g>\n  <!-- evStart(evStart) /ID:fd4e1872-8742-4bfa-9c4f-b271ec81c73f /ItemID:ab99ac91-be7d-43c4-955d-04324360fbdf -->\n  <!-- evStart /W:160 /H:160 -->\n  <ellipse cx=\"124.7244\" cy=\"63.49606\" rx=\"22.677164\" ry=\"22.677164\"\n    style=\"shape-rendering:auto; stroke:#808080; stroke-width:1px; stroke-linecap:round;\n    stroke-dasharray:; stroke-opacity:1; fill:#FFFFFF; fill-opacity:1;\"></ellipse>\n  <!-- ##ATS##_evTypeShapeCatchMessage /W:80 /H:80 -->\n  <rect x=\"113.5\" y=\"55.5\" rx=\"2.2677164\" ry=\"2.2677164\" width=\"22\" height=\"16\"\n    style=\"stroke:#000000; stroke-width:1px; stroke-linecap:round; stroke-dasharray:;\n    stroke-opacity:1; fill:#FFFFFF; fill-opacity:1;\"></rect>\n  <path d=\"M113.224396,57.66535L122.295265,65.602356C124.56298,66.73621 124.56298,66.73621 \n    126.830696,65.602356L135.90157,57.66535\" style=\"shape-rendering:auto; stroke:#000000;\n    stroke-width:1px; stroke-linecap:round; stroke-dasharray:; stroke-opacity:1;\n    fill:transparent; fill-opacity:0.0;\"></path>\n  <text class=\"\" x=\"124.5\" y=\"99.92084\" text-anchor=\"middle\"\n    style=\"fill:#444444;font-family:Segoe UI;font-weight:400;font-style:normal;font-size:9pt;text-decoration:none;\">\n    <tspan class=\"\" x=\"124.5\" dy=\"0\">Goods</tspan><tspan class=\"\" x=\"124.5\" dy=\"15\">arrived</tspan></text>\n</g>
\n
\n
\n\n\n\n\n\n
Result JSON a shape - including position and size (and the rendering objects: rect, path and text)
\n
\n
\n
Copy
\n
Copied
\n
\n 
{\n  \"id\": \"ab99ac91-be7d-43c4-955d-04324360fbdf\",\n  \"properties\": {\n    \"column\": 0.0,\n    \"evType\": \"evTypeCatchMessage\",\n    \"height\": 50,\n    \"kind\": \"shape\",\n    \"row\": 0.0,\n    \"type\": \"evStart\",\n    \"typeDisplayName\": \"Start\",\n    \"width\": 50,\n    \"x\": 112.5,\n    \"y\": 45.0\n  },\n  \"attributes\": [\n    {\n      \"key\": \"evStartTrigger\",\n      \"values\": [\n        { \"lcid\": 127, \"value\": \"evTriggerStd\" }\n      ]\n    },\n    {\n      \"key\": \"name\",\n      \"values\": [\n        { \"lcid\": 1033, \"value\": \"Goods arrived\" }\n      ]\n    }\n  ],\n  \"attributeDisplays\": [\n    {\n      \"key\": \"name\",\n      \"width\": 70.0,\n      \"height\": 34.0625,\n      \"xOffset\": -10.0,\n      \"yOffset\": 60.0,\n      \"rotation\": 0.0,\n      \"horizontalAlignment\": \"center\",\n      \"verticalAlignment\": \"top\"\n    }\n  ],\n  \"related\": [\n    {\n      \"key\": \"executiveRole\",\n      \"shortKey\": \"R\",\n      \"ids\": [\n        \"4c71d84e-2084-4dc1-bda4-dd2ff664aba4\"\n      ]\n    }\n  ]\n}
\n
\n
\n

Sample 2 (an edge)

\n

For basics about the edges see section The edges collection.

\n

BPMN sample for interpolation points of an edge

\n
\n
\n \n \n \n \n \n`, `61183049066386380000`)\"\n >\n
Copy
\n
Copied
\n
\n 
<bpmndi:BPMNEdge id=\"SequenceFlow_1vmk1br_di\" bpmnElement=\"SequenceFlow_1vmk1br\">\n  <di:waypoint xsi:type=\"dc:Point\" x=\"209\" y=\"331\" />\n  <di:waypoint xsi:type=\"dc:Point\" x=\"245\" y=\"331\" />\n  <bpmndi:BPMNLabel>\n    <dc:Bounds x=\"182\" y=\"310\" width=\"90\" height=\"12\" />\n  </bpmndi:BPMNLabel>\n</bpmndi:BPMNEdge>
\n
","headings":[{"value":"Request JSON","depth":1},{"value":"Table of contents","depth":2},{"value":"1. - General structure of the Request JSON","depth":2},{"value":"2.0 - The diagram meta-information part of the Request JSON","depth":2},{"value":"2.1 - How it typically looks like","depth":3},{"value":"2.2 - The requested result type","depth":3},{"value":"2.3 - The requested calculation type","depth":3},{"value":"2.4 - The configurations","depth":3},{"value":"3.0 - The context part of the Request JSON (diagram as a whole)","depth":2},{"value":"3.1 - How it typically looks like","depth":3},{"value":"3.2 - Context informations","depth":3},{"value":"4.0 - The content part of the Request JSON (containing the nodes and edges collections)","depth":2},{"value":"4.1 - How it typically looks like","depth":3},{"value":"4.2 - The nodes collection","depth":3},{"value":"The laneRelevantRelated collection","depth":4},{"value":"4.3 - The edges collection","depth":3},{"value":"5.0 - The pools part of the Request JSON","depth":2},{"value":"5.1 - How it typically looks like","depth":3},{"value":"5.2 - The pool servity","depth":3},{"value":"6.0 - The elements part of the Request JSON","depth":2},{"value":"6.1 - How it typically looks like for events","depth":3},{"value":"6.2 - How it typically looks like for tasks","depth":3},{"value":"6.3 - How it typically looks like for roles","depth":3},{"value":"6.4 - How it typically looks like for data","depth":3},{"value":"Edges and edge items","depth":3},{"value":"Lane items","depth":3},{"value":"Understanding the correlation of nodes / edges and elements by examples","depth":2},{"value":"Sample 1 (a node/shape and the underlaying element vs. the BPMN equivalent)","depth":3},{"value":"Sample 2 (an edge)","depth":3}]},"contentItem":{"data":{"lastModified":"2025-09-10T14:16:09.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"4a04c0b7-690b-58b1-bd03-1341c1939a12__redocly content/cpm/developer/services/graphic/request_json/","seo":{"title":"Request JSON","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/developer/services/graphic/request_json.md","pageBaseUrl":"/cpm/developer/services/graphic/request_json","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Request JSON","id":"request-json"},{"depth":2,"value":"Table of contents","id":"table-of-contents"},{"depth":2,"value":"1. - General structure of the Request JSON","id":"a-namegen-struct1---general-structure-of-the-request-jsona"},{"depth":2,"value":"2.0 - The diagram meta-information part of the Request JSON","id":"a-namedgm-meta20---the-diagram-meta-information-part-of-the-request-jsona"},{"depth":3,"value":"2.1 - How it typically looks like","id":"a-namedgm-meta-typic21---how-it-typically-looks-likea"},{"depth":3,"value":"2.2 - The requested result type","id":"a-namedgm-meta-result22---the-requested-coderesultcode-typea"},{"depth":3,"value":"2.3 - The requested calculation type","id":"a-namedgm-meta-calc23---the-requested-codecalculationcode-typea"},{"depth":3,"value":"2.4 - The configurations","id":"a-namedgm-meta-conf24---the-codeconfigurationscodea"},{"depth":2,"value":"3.0 - The context part of the Request JSON (diagram as a whole)","id":"a-namecontext-part30---the-context-part-of-the-request-json-diagram-as-a-wholea"},{"depth":3,"value":"3.1 - How it typically looks like","id":"a-namecontext-part-typic31---how-it-typically-looks-likea"},{"depth":3,"value":"3.2 - Context informations","id":"a-namecontext-part-info32---context-informationsa"},{"depth":2,"value":"4.0 - The content part of the Request JSON (containing the nodes and edges collections)","id":"a-namecontent-part40---the-codecontentcode-part-of-the-request-json-containing-the-nodes-and-edges-collectionsa"},{"depth":3,"value":"4.1 - How it typically looks like","id":"a-namecontent-part-typic41---how-it-typically-looks-likea"},{"depth":3,"value":"4.2 - The nodes collection","id":"a-namecontent-part-nodes42---the-codenodescode-collectiona"},{"depth":4,"value":"The laneRelevantRelated collection","id":"a-namecontent-part-nodes-lane-relevancethe-codelanerelevantrelatedcode-collectiona"},{"depth":3,"value":"4.3 - The edges collection","id":"a-namecontent-part-edges43---the-codeedgescode-collectiona"},{"depth":2,"value":"5.0 - The pools part of the Request JSON","id":"a-namepools-part50---the-codepoolscode-part-of-the-request-jsona"},{"depth":3,"value":"5.1 - How it typically looks like","id":"a-namepools-part-typic51---how-it-typically-looks-likea"},{"depth":3,"value":"5.2 - The pool servity","id":"a-namepools-part-tune52---the-codepoolcode-servitya"},{"depth":2,"value":"6.0 - The elements part of the Request JSON","id":"a-nameelements-part60---the-codeelementscode-part-of-the-request-jsona"},{"depth":3,"value":"6.1 - How it typically looks like for events","id":"a-nameelements-part-typic-events61---how-it-typically-looks-like-for-eventsa"},{"depth":3,"value":"6.2 - How it typically looks like for tasks","id":"a-nameelements-part-typic-tasks62---how-it-typically-looks-like-for-tasksa"},{"depth":3,"value":"6.3 - How it typically looks like for roles","id":"a-nameelements-part-typic-roles63---how-it-typically-looks-like-for-rolesa"},{"depth":3,"value":"6.4 - How it typically looks like for data","id":"a-nameelements-part-typic-data64---how-it-typically-looks-like-for-dataa"},{"depth":3,"value":"Edges and edge items","id":"edges-and-edge-items"},{"depth":3,"value":"Lane items","id":"lane-items"},{"depth":2,"value":"Understanding the correlation of nodes / edges and elements by examples","id":"a-namecorrelationunderstanding-the-correlation-of-codenodescode--codeedgescode--and-codeelementscode-by-examplesa"},{"depth":3,"value":"Sample 1 (a node/shape and the underlaying element vs. the BPMN equivalent)","id":"a-namecorrelation-sample1sample-1-a-nodeshape-and-the-underlaying-element-vs-the-bpmn-equivalenta"},{"depth":3,"value":"Sample 2 (an edge)","id":"sample-2-an-edge"}]},"data":{"title":""},"catalogInfo":null,"link":"/cpm/developer/services/graphic/request_json/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}