WorkflowInstance

the workflow instance API

put

Path parameters

idinteger · int64Required

ID of workflow-instance

Responses

200

OK

No content

put

/cmn/workflow-instances/{id}/resume

HTTPcURLJavaScriptPython

PUT /api/cmn/workflow-instances/{id}/resume HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

put

Path parameters

idinteger · int64Required

ID of workflow-instance

Responses

200

OK

No content

put

/cmn/workflow-instances/{id}/kill

HTTPcURLJavaScriptPython

PUT /api/cmn/workflow-instances/{id}/kill HTTP/1.1
Host: localhost:53907
Accept: */*

200

OK

No content

get

Path parameters

idinteger · int64Required

ID einer Workflow-Instant

Responses

200

OK

application/json

get

/cmn/workflow-instances/{id}

HTTPcURLJavaScriptPython

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

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:14:53.146Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:14:53.146Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "state": "CREATED",
  "workflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "workItems": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T16:14:53.146Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T16:14:53.146Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "state": "OPEN",
      "workflowElementRef": 1,
      "parentWorkItemRef": 1,
      "responsibleUserRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "logEntries": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T16:14:53.146Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T16:14:53.146Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "workflowInstanceId": 1,
          "workItemId": 1,
          "logTime": "2026-02-10T16:14:53.146Z",
          "origin": "DEBUG",
          "message": "text",
          "messageKey": "text",
          "propertyPath": "text",
          "messageParameter": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        }
      ],
      "splitResult": "text"
    }
  ],
  "logEntries": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T16:14:53.146Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T16:14:53.146Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "workflowInstanceId": 1,
      "workItemId": 1,
      "logTime": "2026-02-10T16:14:53.146Z",
      "origin": "DEBUG",
      "message": "text",
      "messageKey": "text",
      "propertyPath": "text",
      "messageParameter": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}

Liefert den Status der aktuellen Workflow-Instanz zu der gegebenen Referenz

get

Path parameters

referenceIdinteger · int64Required

referenceKeystringRequired

Responses

200

Workflow-Instanz gefunden

application/json

Responsestring · enum

Status einer Workflow-Instanz

Possible values:

404

Es existiert noch keine Workflow-Instanz

application/json

get

/cmn/workflow-instances/workflow-state/{referenceKey}/{referenceId}

HTTPcURLJavaScriptPython

GET /api/cmn/workflow-instances/workflow-state/{referenceKey}/{referenceId} HTTP/1.1
Host: localhost:53907
Accept: */*

CREATED

Liefert ein Query-Preset zur Selektion aller Workflow-Instanzen zu der gegebenen Referenz

get

Path parameters

referenceIdinteger · int64Required

referenceKeystringRequired

Responses

200

Workflow-Instanz gefunden

application/json

get

/cmn/workflow-instances/workflow-instances-preset/{referenceKey}/{referenceId}

HTTPcURLJavaScriptPython

GET /api/cmn/workflow-instances/workflow-instances-preset/{referenceKey}/{referenceId} HTTP/1.1
Host: localhost:53907
Accept: */*

200

Workflow-Instanz gefunden

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:14:53.146Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:14:53.146Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "QUERY",
  "templateId": "text",
  "templateGroupKey": "text",
  "label": "text",
  "uiPayload": {},
  "variables": [
    {
      "path": "text",
      "definition": {
        "_type": "text",
        "attribute": "text",
        "path": "text",
        "displayName": "text",
        "displayNameOverride": false,
        "groupDisplayName": "text",
        "parentDisplayName": "text",
        "resultable": true,
        "filterable": true,
        "sortable": true,
        "visible": true,
        "functions": [
          "text"
        ],
        "sortDirection": "text",
        "constraint": {
          "minLength": 1,
          "maxLength": 1,
          "minValue": 1,
          "includeMinValue": true,
          "maxValue": 1,
          "includeMaxValue": true,
          "notNull": false,
          "notBlank": true
        },
        "dataType": {
          "identifier": "text",
          "jsType": "text",
          "objectRefIdentifier": "text",
          "filterOptions": {
            "filterValues": [
              "text"
            ],
            "filterDialog": {},
            "multipleChoice": false
          },
          "functions": [
            "text"
          ],
          "predicateOperations": [
            "AND"
          ]
        },
        "dataTypeIdentifier": "text",
        "modelType": "STATIC",
        "headers": [
          {
            "displayName": "text",
            "displayNameOverride": false,
            "dataType": {
              "identifier": "text",
              "jsType": "text",
              "objectRefIdentifier": "text",
              "filterOptions": {
                "filterValues": [
                  "text"
                ],
                "filterDialog": {},
                "multipleChoice": false
              },
              "functions": [
                "text"
              ],
              "predicateOperations": [
                "AND"
              ]
            },
            "dataTypeIdentifier": "text",
            "groupDisplayName": "text",
            "data": {}
          }
        ]
      },
      "mandatory": true,
      "variableName": "text",
      "visible": true,
      "alignX": 1,
      "alignY": 1,
      "alignWidth": 1,
      "searchDialog": {},
      "allowDialogMultipleChoice": false
    }
  ],
  "queryStatement": "text",
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [
      {
        "type": "JUNCTION",
        "operator": "AND",
        "children": [
          {
            "type": "JUNCTION",
            "operator": "AND",
            "children": "[Circular Reference]",
            "property": "text",
            "values": [
              "text"
            ],
            "visible": true,
            "functions": [
              "text"
            ]
          }
        ],
        "property": "text",
        "values": [
          "text"
        ],
        "visible": true,
        "functions": [
          "text"
        ]
      }
    ],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "results": [
    {
      "property": "text",
      "displayName": "text",
      "functions": [
        "text"
      ],
      "visible": true
    }
  ],
  "sortAndOrders": [
    {
      "property": "text",
      "functions": [
        "text"
      ],
      "direction": "ASC"
    }
  ],
  "pageable": {
    "limit": 1
  },
  "option": {
    "distinctResult": true
  },
  "transformations": [
    {
      "crossTable": {
        "rowSpecs": [
          {
            "property": "text",
            "displayName": "text",
            "functions": [
              "text"
            ],
            "visible": true
          }
        ],
        "columnSpecs": [
          {
            "property": "text",
            "displayName": "text",
            "functions": [
              "text"
            ],
            "visible": true
          }
        ],
        "results": [
          {
            "result": {
              "property": "text",
              "displayName": "text",
              "functions": [
                "text"
              ],
              "visible": true
            },
            "cellView": "AS_IS",
            "sumColumn": false,
            "rowMode": "DATA",
            "aggregateFunction": "text"
          }
        ]
      }
    }
  ],
  "arithmeticQueryTerms": [
    {
      "termName": "text",
      "terms": [
        {
          "fragment": {
            "operations": [
              "PLUS"
            ]
          },
          "attribute": "text",
          "fixedValue": 1
        }
      ],
      "operations": [
        "PLUS"
      ]
    }
  ],
  "definition": [
    {
      "_type": "text",
      "attribute": "text",
      "path": "text",
      "displayName": "text",
      "displayNameOverride": false,
      "groupDisplayName": "text",
      "parentDisplayName": "text",
      "resultable": true,
      "filterable": true,
      "sortable": true,
      "visible": true,
      "functions": [
        "text"
      ],
      "sortDirection": "text",
      "constraint": {
        "minLength": 1,
        "maxLength": 1,
        "minValue": 1,
        "includeMinValue": true,
        "maxValue": 1,
        "includeMaxValue": true,
        "notNull": false,
        "notBlank": true
      },
      "dataType": {
        "identifier": "text",
        "jsType": "text",
        "objectRefIdentifier": "text",
        "filterOptions": {
          "filterValues": [
            "text"
          ],
          "filterDialog": {},
          "multipleChoice": false
        },
        "functions": [
          "text"
        ],
        "predicateOperations": [
          "AND"
        ]
      },
      "dataTypeIdentifier": "text",
      "modelType": "STATIC",
      "headers": [
        {
          "displayName": "text",
          "displayNameOverride": false,
          "dataType": {
            "identifier": "text",
            "jsType": "text",
            "objectRefIdentifier": "text",
            "filterOptions": {
              "filterValues": [
                "text"
              ],
              "filterDialog": {},
              "multipleChoice": false
            },
            "functions": [
              "text"
            ],
            "predicateOperations": [
              "AND"
            ]
          },
          "dataTypeIdentifier": "text",
          "groupDisplayName": "text",
          "data": {}
        }
      ]
    }
  ],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T16:14:53.146Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T16:14:53.146Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T16:14:53.146Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T16:14:53.146Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "userRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "operation": "READ_ONLY"
      }
    ],
    "groupPermissions": [
      {
        "version": "text",
        "info": {
          "createdAt": "2026-02-10T16:14:53.146Z",
          "createdFrom": "text",
          "updatedAt": "2026-02-10T16:14:53.146Z",
          "updatedFrom": "text"
        },
        "id": "text",
        "groupRef": {
          "id": "text",
          "label": "text",
          "description": "text",
          "active": true
        },
        "operation": "READ_ONLY"
      }
    ],
    "operationForAllUsers": "READ_ONLY"
  },
  "forWorkflow": false,
  "userOptions": {
    "version": "text",
    "info": {
      "createdAt": "2026-02-10T16:14:53.146Z",
      "createdFrom": "text",
      "updatedAt": "2026-02-10T16:14:53.146Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "pinned": false
  }
}

Liefert die neuste Workflow-Instanz zu der gegebenen Referenz

get

Path parameters

referenceIdinteger · int64Required

referenceKeystringRequired

Responses

200

Workflow-Instanz gefunden

application/json

404

Es existiert noch keine Workflow-Instanz

application/json

get

/cmn/workflow-instances/latest-workflow-instance/{referenceKey}/{referenceId}

HTTPcURLJavaScriptPython

GET /api/cmn/workflow-instances/latest-workflow-instance/{referenceKey}/{referenceId} HTTP/1.1
Host: localhost:53907
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-02-10T16:14:53.146Z",
    "createdFrom": "text",
    "updatedAt": "2026-02-10T16:14:53.146Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "state": "CREATED",
  "workflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "workItems": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T16:14:53.146Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T16:14:53.146Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "state": "OPEN",
      "workflowElementRef": 1,
      "parentWorkItemRef": 1,
      "responsibleUserRef": {
        "id": "text",
        "label": "text",
        "description": "text",
        "active": true
      },
      "logEntries": [
        {
          "version": "text",
          "info": {
            "createdAt": "2026-02-10T16:14:53.146Z",
            "createdFrom": "text",
            "updatedAt": "2026-02-10T16:14:53.146Z",
            "updatedFrom": "text"
          },
          "id": "text",
          "workflowInstanceId": 1,
          "workItemId": 1,
          "logTime": "2026-02-10T16:14:53.146Z",
          "origin": "DEBUG",
          "message": "text",
          "messageKey": "text",
          "propertyPath": "text",
          "messageParameter": {
            "ANY_ADDITIONAL_PROPERTY": {}
          }
        }
      ],
      "splitResult": "text"
    }
  ],
  "logEntries": [
    {
      "version": "text",
      "info": {
        "createdAt": "2026-02-10T16:14:53.146Z",
        "createdFrom": "text",
        "updatedAt": "2026-02-10T16:14:53.146Z",
        "updatedFrom": "text"
      },
      "id": "text",
      "workflowInstanceId": 1,
      "workItemId": 1,
      "logTime": "2026-02-10T16:14:53.146Z",
      "origin": "DEBUG",
      "message": "text",
      "messageKey": "text",
      "propertyPath": "text",
      "messageParameter": {
        "ANY_ADDITIONAL_PROPERTY": {}
      }
    }
  ]
}