Workflow

the workflow API

Find an existing Resource by identifier

get

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource with given ID was not found

application/json

get

/cmn/workflows/{id}

HTTPcURLJavaScriptPython

GET /api/cmn/workflows/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

Update existing Resource

put

Path parameters

idinteger · int64Required

an identifier

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

namestringRequired

Name des Workflows

descriptionstring · nullableOptional

Beschreibung des Workflows

triggerstringOptional

Wann wird dieser Workflow ausgelöst?

subWorkflowbooleanRequired

Handelt es sich um einen Unter-Workflow?

Default: false

statestring · enumRead-onlyOptional

Status des Workflows

Default: DRAFTPossible values:

synchronousbooleanRead-onlyOptional

Synchroner Workflow?

Responses

200

successful operation

application/json

404

Resource was not found

application/json

422

Resource was not valid to process

application/json

put

/cmn/workflows/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "version": "text",
  "info": {},
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "successorRef": {
    "id": "text"
  },
  "predecessorRef": {
    "id": "text"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

Delete an existing Resource

delete

Path parameters

idinteger · int64Required

an identifier

Responses

200

successful operation

application/json

404

Resource was not found

application/json

409

unable to delete Resource, due to constraints, existing references or internal state

application/json

delete

/cmn/workflows/{id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/workflows/{id} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "context": "text",
  "messageValue": "text"
}

get

Path parameters

idinteger · int64Required

element-idinteger · int64Required

Responses

200

OK

application/json

get

/cmn/workflows/{id}/workflow-elements/{element-id}

HTTPcURLJavaScriptPython

GET /api/cmn/workflows/{id}/workflow-elements/{element-id} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "START_EVENT",
  "script": "text",
  "scriptModuleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:45:44.712Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:45:44.712Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "name": "text",
      "requiredValueType": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "attributePath": "text"
    }
  ],
  "sequelElementRefs": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "executeOnSplitResult": "text"
    }
  ],
  "uiData": {},
  "intermediateEventIdentifiers": [
    "text"
  ],
  "triggerSingleInstance": true,
  "guardingIntervalInSeconds": 1,
  "possibleSplitResults": [
    "text"
  ],
  "timeoutAfterSeconds": 1,
  "responsibleUserRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "responsibleUserGroupRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "userDecisions": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:45:44.712Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:45:44.712Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "workItemId": 1,
      "resultName": "text",
      "prompt": "text",
      "valueType": "text",
      "choiceOptions": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:45:44.712Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:45:44.712Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "label": "text",
          "value": "text",
          "followUpUserDecision": {
            "version": "text",
            "info": {
              "createdAt": "2026-02-10T17:45:44.712Z",
              "createdFrom": "text",
              "updatedAt": "2026-02-10T17:45:44.712Z",
              "updatedFrom": "text"
            },
            "id": "text",
            "workItemId": 1,
            "resultName": "text",
            "prompt": "text",
            "valueType": "text",
            "choiceOptions": "[Circular Reference]",
            "searchDialog": "text",
            "trySynchronous": false,
            "multipleChoiceAllowed": true
          },
          "defaultValue": true
        }
      ],
      "searchDialog": "text",
      "trySynchronous": false,
      "multipleChoiceAllowed": true
    }
  ],
  "responsibleUserIsExecutingUser": false,
  "subWorkflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

put

Path parameters

idinteger · int64Required

element-idinteger · int64Required

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

namestringOptional

Name des Elements

descriptionstring · nullableOptional

Ggf weitere Beschreibung

typestring · enumOptional

Gibt an, um welche Art von Element es sich bei einem WorkflowElement handelt

Possible values:

scriptstringOptional

Skript, welches ausgeführt werden soll

uiDataobjectOptional

Search-Dialog

intermediateEventIdentifiersstring[]Optional

Für INTERMEDIATE_EVENT: wodurch wird dieses Event getriggert?

triggerSingleInstancebooleanOptional

Für INTERMEDIATE_EVENT: kann nur in der definierten Instanz getriggert werden

Default: true

guardingIntervalInSecondsinteger · int32Optional

Für INTERMEDIATE_EVENT: definiert ein Abfrage-Intervall, zu dem das Intermediate-Event überprüft wird, ob eine Ausführung des Skripts möglich ist. Nur in Verbindung mit delayInSeconds

possibleSplitResultsstring[]Optional

Mögliche Ergebnisse/Ausgänge beim Split

timeoutAfterSecondsinteger · int64 · nullableOptional

Verzögerung von Timern

responsibleUserIsExecutingUserbooleanOptional

Der ausführende Benutzer ist auch der verantwortliche Benutzer

Default: false

Responses

200

OK

application/json

put

/cmn/workflows/{id}/workflow-elements/{element-id}

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id}/workflow-elements/{element-id} HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 1159

{
  "version": "text",
  "info": {},
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "START_EVENT",
  "script": "text",
  "scriptModuleRef": {
    "id": "text"
  },
  "parameters": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "name": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text"
      },
      "attributePath": "text"
    }
  ],
  "uiData": {},
  "intermediateEventIdentifiers": [
    "text"
  ],
  "triggerSingleInstance": true,
  "guardingIntervalInSeconds": 1,
  "possibleSplitResults": [
    "text"
  ],
  "timeoutAfterSeconds": 1,
  "responsibleUserRefs": [
    {
      "id": "text"
    }
  ],
  "responsibleUserGroupRefs": [
    {
      "id": "text"
    }
  ],
  "userDecisions": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "resultName": "text",
      "prompt": "text",
      "valueType": "text",
      "choiceOptions": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "label": "text",
          "value": "text",
          "followUpUserDecision": {
            "version": "text",
            "info": {},
            "id": "text",
            "resultName": "text",
            "prompt": "text",
            "valueType": "text",
            "choiceOptions": "[Circular Reference]",
            "searchDialog": "text",
            "trySynchronous": false,
            "multipleChoiceAllowed": true
          },
          "defaultValue": true
        }
      ],
      "searchDialog": "text",
      "trySynchronous": false,
      "multipleChoiceAllowed": true
    }
  ],
  "responsibleUserIsExecutingUser": false,
  "subWorkflowRef": {
    "id": "text"
  }
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "START_EVENT",
  "script": "text",
  "scriptModuleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:45:44.712Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:45:44.712Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "name": "text",
      "requiredValueType": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "attributePath": "text"
    }
  ],
  "sequelElementRefs": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "executeOnSplitResult": "text"
    }
  ],
  "uiData": {},
  "intermediateEventIdentifiers": [
    "text"
  ],
  "triggerSingleInstance": true,
  "guardingIntervalInSeconds": 1,
  "possibleSplitResults": [
    "text"
  ],
  "timeoutAfterSeconds": 1,
  "responsibleUserRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "responsibleUserGroupRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "userDecisions": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:45:44.712Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:45:44.712Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "workItemId": 1,
      "resultName": "text",
      "prompt": "text",
      "valueType": "text",
      "choiceOptions": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:45:44.712Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:45:44.712Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "label": "text",
          "value": "text",
          "followUpUserDecision": {
            "version": "text",
            "info": {
              "createdAt": "2026-02-10T17:45:44.712Z",
              "createdFrom": "text",
              "updatedAt": "2026-02-10T17:45:44.712Z",
              "updatedFrom": "text"
            },
            "id": "text",
            "workItemId": 1,
            "resultName": "text",
            "prompt": "text",
            "valueType": "text",
            "choiceOptions": "[Circular Reference]",
            "searchDialog": "text",
            "trySynchronous": false,
            "multipleChoiceAllowed": true
          },
          "defaultValue": true
        }
      ],
      "searchDialog": "text",
      "trySynchronous": false,
      "multipleChoiceAllowed": true
    }
  ],
  "responsibleUserIsExecutingUser": false,
  "subWorkflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

delete

Path parameters

idinteger · int64Required

element-idinteger · int64Required

Responses

200

OK

application/json

delete

/cmn/workflows/{id}/workflow-elements/{element-id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/workflows/{id}/workflow-elements/{element-id} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "context": "text",
  "messageValue": "text"
}

put

Path parameters

idinteger · int64Required

Responses

200

successful operation

application/json

404

workflow not found

application/json

put

/cmn/workflows/{id}/setSavePointBeginEditing

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id}/setSavePointBeginEditing HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

put

Path parameters

idinteger · int64Required

Responses

200

successful operation

application/json

404

workflow not found

application/json

put

/cmn/workflows/{id}/restoreSavePointAfterCancelEditing

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id}/restoreSavePointAfterCancelEditing HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

put

Path parameters

idinteger · int64Required

Responses

200

successful operation

application/json

404

workflow not found

application/json

put

/cmn/workflows/{id}/restoreNextSavePoint

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id}/restoreNextSavePoint HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

put

Path parameters

idinteger · int64Required

Responses

200

successful operation

application/json

404

workflow not found

application/json

put

/cmn/workflows/{id}/restoreLastSavePoint

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id}/restoreLastSavePoint HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

put

Path parameters

idinteger · int64Required

Responses

200

successful operation

application/json

404

workflow not found

application/json

put

/cmn/workflows/{id}/deactivate

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id}/deactivate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

put

Path parameters

idinteger · int64Required

Body

application/json

namestringRequired

der neue Name für den Workflow

descriptionstringOptional

die neue Beschreibung des Worklflows

Responses

200

OK

application/json

put

/cmn/workflows/{id}/changeNameAndDescription

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id}/changeNameAndDescription HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "description": "text"
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

put

Path parameters

idinteger · int64Required

Responses

200

successful operation

application/json

404

workflow not found

application/json

put

/cmn/workflows/{id}/activate

HTTPcURLJavaScriptPython

PUT /api/cmn/workflows/{id}/activate HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

Create new Resource

post

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

namestringRequired

Name des Workflows

descriptionstring · nullableOptional

Beschreibung des Workflows

triggerstringOptional

Wann wird dieser Workflow ausgelöst?

subWorkflowbooleanRequired

Handelt es sich um einen Unter-Workflow?

Default: false

statestring · enumRead-onlyOptional

Status des Workflows

Default: DRAFTPossible values:

synchronousbooleanRead-onlyOptional

Synchroner Workflow?

Responses

200

successful operation

application/json

422

Resource was not valid to process

application/json

post

/cmn/workflows

HTTPcURLJavaScriptPython

POST /api/cmn/workflows HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "version": "text",
  "info": {},
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "successorRef": {
    "id": "text"
  },
  "predecessorRef": {
    "id": "text"
  }
}

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

get

Path parameters

idinteger · int64Required

Responses

200

OK

application/json

get

/cmn/workflows/{id}/workflow-elements

HTTPcURLJavaScriptPython

GET /api/cmn/workflows/{id}/workflow-elements HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T17:45:44.712Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T17:45:44.712Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "name": "text",
    "description": "text",
    "type": "START_EVENT",
    "script": "text",
    "scriptModuleRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    },
    "parameters": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:45:44.712Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:45:44.712Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "name": "text",
        "requiredValueType": "text",
        "fixedValue": "text",
        "fixedValueType": "text",
        "queryPresetRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "attributePath": "text"
      }
    ],
    "sequelElementRefs": [
      {
        "id": 1,
        "name": "text",
        "description": "text",
        "executeOnSplitResult": "text"
      }
    ],
    "uiData": {},
    "intermediateEventIdentifiers": [
      "text"
    ],
    "triggerSingleInstance": true,
    "guardingIntervalInSeconds": 1,
    "possibleSplitResults": [
      "text"
    ],
    "timeoutAfterSeconds": 1,
    "responsibleUserRefs": [
      {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    ],
    "responsibleUserGroupRefs": [
      {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      }
    ],
    "userDecisions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T17:45:44.712Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T17:45:44.712Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "workItemId": 1,
        "resultName": "text",
        "prompt": "text",
        "valueType": "text",
        "choiceOptions": [
          {
            "version": "text",
            "info": {
              "createdAt": "2026-02-10T17:45:44.712Z",
              "createdFrom": "text",
              "updatedAt": "2026-02-10T17:45:44.712Z",
              "updatedFrom": "text"
            },
            "id": "text",
            "label": "text",
            "value": "text",
            "followUpUserDecision": "[Circular Reference]",
            "defaultValue": true
          }
        ],
        "searchDialog": "text",
        "trySynchronous": false,
        "multipleChoiceAllowed": true
      }
    ],
    "responsibleUserIsExecutingUser": false,
    "subWorkflowRef": {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  }
]

post

Path parameters

idinteger · int64Required

Body

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

namestringOptional

Name des Elements

descriptionstring · nullableOptional

Ggf weitere Beschreibung

typestring · enumOptional

Gibt an, um welche Art von Element es sich bei einem WorkflowElement handelt

Possible values:

scriptstringOptional

Skript, welches ausgeführt werden soll

uiDataobjectOptional

Search-Dialog

intermediateEventIdentifiersstring[]Optional

Für INTERMEDIATE_EVENT: wodurch wird dieses Event getriggert?

triggerSingleInstancebooleanOptional

Für INTERMEDIATE_EVENT: kann nur in der definierten Instanz getriggert werden

Default: true

guardingIntervalInSecondsinteger · int32Optional

Für INTERMEDIATE_EVENT: definiert ein Abfrage-Intervall, zu dem das Intermediate-Event überprüft wird, ob eine Ausführung des Skripts möglich ist. Nur in Verbindung mit delayInSeconds

possibleSplitResultsstring[]Optional

Mögliche Ergebnisse/Ausgänge beim Split

timeoutAfterSecondsinteger · int64 · nullableOptional

Verzögerung von Timern

responsibleUserIsExecutingUserbooleanOptional

Der ausführende Benutzer ist auch der verantwortliche Benutzer

Default: false

Responses

200

OK

application/json

post

/cmn/workflows/{id}/workflow-elements

HTTPcURLJavaScriptPython

POST /api/cmn/workflows/{id}/workflow-elements HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 1159

{
  "version": "text",
  "info": {},
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "START_EVENT",
  "script": "text",
  "scriptModuleRef": {
    "id": "text"
  },
  "parameters": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "name": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text"
      },
      "attributePath": "text"
    }
  ],
  "uiData": {},
  "intermediateEventIdentifiers": [
    "text"
  ],
  "triggerSingleInstance": true,
  "guardingIntervalInSeconds": 1,
  "possibleSplitResults": [
    "text"
  ],
  "timeoutAfterSeconds": 1,
  "responsibleUserRefs": [
    {
      "id": "text"
    }
  ],
  "responsibleUserGroupRefs": [
    {
      "id": "text"
    }
  ],
  "userDecisions": [
    {
      "version": "text",
      "info": {},
      "id": "text",
      "resultName": "text",
      "prompt": "text",
      "valueType": "text",
      "choiceOptions": [
        {
          "version": "text",
          "info": {},
          "id": "text",
          "label": "text",
          "value": "text",
          "followUpUserDecision": {
            "version": "text",
            "info": {},
            "id": "text",
            "resultName": "text",
            "prompt": "text",
            "valueType": "text",
            "choiceOptions": "[Circular Reference]",
            "searchDialog": "text",
            "trySynchronous": false,
            "multipleChoiceAllowed": true
          },
          "defaultValue": true
        }
      ],
      "searchDialog": "text",
      "trySynchronous": false,
      "multipleChoiceAllowed": true
    }
  ],
  "responsibleUserIsExecutingUser": false,
  "subWorkflowRef": {
    "id": "text"
  }
}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "type": "START_EVENT",
  "script": "text",
  "scriptModuleRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "parameters": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:45:44.712Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:45:44.712Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "name": "text",
      "requiredValueType": "text",
      "fixedValue": "text",
      "fixedValueType": "text",
      "queryPresetRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "attributePath": "text"
    }
  ],
  "sequelElementRefs": [
    {
      "id": 1,
      "name": "text",
      "description": "text",
      "executeOnSplitResult": "text"
    }
  ],
  "uiData": {},
  "intermediateEventIdentifiers": [
    "text"
  ],
  "triggerSingleInstance": true,
  "guardingIntervalInSeconds": 1,
  "possibleSplitResults": [
    "text"
  ],
  "timeoutAfterSeconds": 1,
  "responsibleUserRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "responsibleUserGroupRefs": [
    {
      "id": "text",
      "label": "text",
      "description": "text",
      "active": true
    }
  ],
  "userDecisions": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T17:45:44.712Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T17:45:44.712Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "workItemId": 1,
      "resultName": "text",
      "prompt": "text",
      "valueType": "text",
      "choiceOptions": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T17:45:44.712Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T17:45:44.712Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "label": "text",
          "value": "text",
          "followUpUserDecision": {
            "version": "text",
            "info": {
              "createdAt": "2026-02-10T17:45:44.712Z",
              "createdFrom": "text",
              "updatedAt": "2026-02-10T17:45:44.712Z",
              "updatedFrom": "text"
            },
            "id": "text",
            "workItemId": 1,
            "resultName": "text",
            "prompt": "text",
            "valueType": "text",
            "choiceOptions": "[Circular Reference]",
            "searchDialog": "text",
            "trySynchronous": false,
            "multipleChoiceAllowed": true
          },
          "defaultValue": true
        }
      ],
      "searchDialog": "text",
      "trySynchronous": false,
      "multipleChoiceAllowed": true
    }
  ],
  "responsibleUserIsExecutingUser": false,
  "subWorkflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

post

Path parameters

idinteger · int64Required

source-idinteger · int64Required

target-idinteger · int64Required

Query parameters

executeOnSplitResultstringOptional

Responses

200

OK

No content

post

/cmn/workflows/{id}/workflow-elements/edge/{source-id}/to/{target-id}

HTTPcURLJavaScriptPython

POST /api/cmn/workflows/{id}/workflow-elements/edge/{source-id}/to/{target-id} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

delete

Path parameters

idinteger · int64Required

source-idinteger · int64Required

target-idinteger · int64Required

Responses

200

OK

No content

delete

/cmn/workflows/{id}/workflow-elements/edge/{source-id}/to/{target-id}

HTTPcURLJavaScriptPython

DELETE /api/cmn/workflows/{id}/workflow-elements/edge/{source-id}/to/{target-id} HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

post

Body

application/json

Führt ein Skript in einer "Sandbox" aus

workflowIdinteger · int64Required

ID des Workflows, in dessen Kontext das Skript ausgeführt werden soll

workflowElementTypestring · enumRequired

Gibt an, um welche Art von Element es sich bei einem WorkflowElement handelt

Possible values:

scriptstringRequired

Das auszuführende Skript

Responses

200

OK

application/json

Responseobject

post

/cmn/workflows/try-execute-script

HTTPcURLJavaScriptPython

POST /api/cmn/workflows/try-execute-script HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 116

{
  "workflowId": 1,
  "workflowElementType": "START_EVENT",
  "script": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

OK

{}

post

Body

application/json

objectOptional

Search-Dialog

Responses

200

OK

application/json

post

/cmn/workflows/import

HTTPcURLJavaScriptPython

POST /api/cmn/workflows/import HTTP/1.1
Host: localhost:53907
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

get

Path parameters

idinteger · int64Required

Query parameters

elementTypestring · enumRequired

Gibt an, um welche Art von Element es sich bei einem WorkflowElement handelt

Possible values:

Responses

200

OK

application/json

get

/cmn/workflows/{id}/script-context-description

HTTPcURLJavaScriptPython

GET /api/cmn/workflows/{id}/script-context-description?elementType=START_EVENT HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "mainInstance": {
    "moduleName": "text",
    "name": "text",
    "description": "text",
    "attributes": [
      {
        "name": "text",
        "description": "text",
        "readOnly": false,
        "dataType": "text",
        "dataTypeName": "text"
      }
    ],
    "methods": [
      {
        "name": "text",
        "description": "text",
        "returnType": "text",
        "returnTypeName": "text",
        "returnDescription": "text",
        "parameters": [
          {
            "name": "text",
            "description": "text",
            "nonNull": false,
            "dataType": "text",
            "dataTypeName": "text"
          }
        ]
      }
    ]
  },
  "availableTypes": [
    {
      "name": "text",
      "description": "text"
    }
  ],
  "availableInput": [
    {
      "name": "text",
      "description": "text",
      "dataType": "text",
      "dataTypeName": "text"
    }
  ]
}

get

Path parameters

idinteger · int64Required

Responses

200

OK

application/json

Responseobject

Search-Dialog

get

/cmn/workflows/{id}/export

HTTPcURLJavaScriptPython

GET /api/cmn/workflows/{id}/export HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{}

get

Path parameters

idinteger · int64Required

Responses

200

OK

application/json

get

/cmn/workflows/{id}/editable-copy

HTTPcURLJavaScriptPython

GET /api/cmn/workflows/{id}/editable-copy HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T17:45:44.712Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T17:45:44.712Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "name": "text",
  "description": "text",
  "trigger": "text",
  "subWorkflow": false,
  "state": "DRAFT",
  "synchronous": true,
  "successorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "predecessorRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  }
}

get

Responses

200

OK

application/json

get

/cmn/workflows/triggers

HTTPcURLJavaScriptPython

GET /api/cmn/workflows/triggers HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "id": "text",
    "topic": "text",
    "triggerName": "text"
  }
]

get

Responses

200

OK

application/json

get

/cmn/workflows/search-dialogs

HTTPcURLJavaScriptPython

GET /api/cmn/workflows/search-dialogs HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

[
  {
    "identifier": "text",
    "searchDialog": {}
  }
]