Entwickler Tutorial (Legacy)
Data Contracts

Data Contracts

Data Contracts können Daten, die von einem Prozess zu einem anderen Prozess oder an ein externes System gesendet werden, auf ein bestimmtes Datenschema validieren. Dies ist besonders hilfreich, um sicherzustellen, dass der andere Prozess oder das externe System mit den Daten arbeiten kann. Bei folgenden Elementen kann ein Data Contract hinzugefügt werden:

  • Call Activity
  • External Service Task
  • Send Task
  • Message/Signal Intermediate Throw Event
  • Message/Signal End Event

Dazu kann im Property Panel unter "Data Contracts" ein Schema deklariert werden.


Das hier deklarierte Schema muss in einem JSON-Format sein. Mithilfe von Keywords lässt sich dann das Schema definieren.

Ein mögliches Beispiel könnte so aussehen:

index.json
1{ 2 "type": "object", 3 "properties": { 4 "foo": { 5 "type": "string", 6 "nullable": true 7 }, 8 "bar": { 9 "type": "integer" 10 } 11 }, 12 "required": ["foo"], 13 "additionalProperties": false 14} 15
index.json
1{ 2 "type": "object", 3 "properties": { 4 "foo": { 5 "type": "string", 6 "nullable": true 7 }, 8 "bar": { 9 "type": "integer" 10 } 11 }, 12 "required": ["foo"], 13 "additionalProperties": false 14} 15

Weitere Informationen zur Erstellung eines Data Contracts, insbesondere weiterer Keywords, können unter dem Link https://json-schema.org/draft/2020-12/json-schema-validation (opens in a new tab) gefunden werden.

Im letzten Schritt, bevor das Element die Daten an den anderen Prozess oder das externe System sendet, werden die Daten nun gegen den Data Contract validiert. Bei einer erfolgreichen Validierung sendet das Element die Daten weiter.


Bei einer fehlgeschlagenen Validierung bricht das Element ab und es wird eine entsprechende Fehlermeldung geworfen.