Workflow Instance

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: 10.102.24.218:32792
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: 10.102.24.218:32792
Accept: */*

200

OK

No content

get

Path parameters

idinteger · int64Required

ID einer Workflow-Instant

Responses

200

OK

application/json

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

statestring · enumOptional

Status einer Workflow-Instanz

Possible values:

get/cmn/workflow-instances/{id}

HTTPcURLJavaScriptPython

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

200

OK

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:04:06.250Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:04:06.250Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "state": "CREATED",
  "workflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "workItems": [],
  "logEntries": []
}

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

get

Path parameters

referenceIdinteger · int64Required

referenceKeystringRequired

Responses

200

Workflow-Instanz gefunden

application/json

string · enumOptional

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: 10.102.24.218:32792
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

Adhoc Preset

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

modestring · enumRequired

Was kann mit diesem Preset abgebildet werden QUERY oder STATEMENT

Default: QUERYPossible values:

templateIdstringRequired

template dem dieser filter zugeordnet worden ist.

templateGroupKeystringRequired

templateGroupKey dem dieser filter zugeordnet worden ist.

labelstringRequired

label für diesen filter

uiPayloadanyOptional

Search-Dialog

queryStatementstringOptional

bei mode == STATEMENT, das vql-query

forWorkflowbooleanRequired

für Workflows vorgesehen

Default: false

outputReportGroupIdentifierstringOptional

Identifier einer OutputReportGroup (moduleKey=cunit), die als Druckvorlage für dieses Preset verwendet wird

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

HTTPcURLJavaScriptPython

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

200

Workflow-Instanz gefunden

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:04:06.250Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:04:06.250Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "mode": "QUERY",
  "templateId": "text",
  "templateGroupKey": "text",
  "label": "text",
  "uiPayload": null,
  "variables": [],
  "queryStatement": "text",
  "queryPredicate": {
    "type": "JUNCTION",
    "operator": "AND",
    "children": [],
    "property": "text",
    "values": [
      "text"
    ],
    "visible": true,
    "functions": [
      "text"
    ]
  },
  "results": [],
  "sortAndOrders": [],
  "pageable": {
    "limit": 1
  },
  "option": {
    "distinctResult": true
  },
  "transformations": [],
  "arithmeticQueryTerms": [],
  "definition": [
    {
      "_type": "text",
      "definition": "[Circular Reference]",
      "value": "[Circular Reference]",
      "key": "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": null,
          "multipleChoice": false
        },
        "functions": [
          "text"
        ],
        "predicateOperations": [
          "AND"
        ]
      },
      "dataTypeIdentifier": "text",
      "modelType": "STATIC",
      "entityIdentifier": "text",
      "referencedEntityIdentifier": "text",
      "headers": []
    }
  ],
  "permissionAggregation": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T01:04:06.250Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T01:04:06.250Z",
      "updatedFrom": "text"
    },
    "id": "text",
    "userPermissions": [],
    "groupPermissions": [],
    "operationForAllUsers": "READ_ONLY"
  },
  "forWorkflow": false,
  "outputReportGroupIdentifier": "text",
  "userOptions": {
    "version": "text",
    "info": {
      "createdAt": "2026-07-21T01:04:06.250Z",
      "createdFrom": "text",
      "updatedAt": "2026-07-21T01:04:06.250Z",
      "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

versionstringOptional

Version Identifier for this Object (for PUT)

idstringOptional

Unique identifier of the Object

statestring · enumOptional

Status einer Workflow-Instanz

Possible values:

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: 10.102.24.218:32792
Accept: */*

{
  "version": "text",
  "info": {
    "createdAt": "2026-07-21T01:04:06.250Z",
    "createdFrom": "text",
    "updatedAt": "2026-07-21T01:04:06.250Z",
    "updatedFrom": "text"
  },
  "id": "text",
  "state": "CREATED",
  "workflowRef": {
    "id": "text",
    "label": "text",
    "description": "text",
    "active": true
  },
  "workItems": [],
  "logEntries": []
}