/
[GET] /variables

[GET] /variables

/api/bpm/tasks/{id}/variables

Description

To retrieve all workflow variables associated with a specific task. If the id of the task is loaded from the history endpoint, the query parameter isComplete must be send with the value true. Otherwise with the default value false.

The result is a list of variables, each containing its name, type, values, and optionally columns that describe the structure of nested data. The values field can include nested lists or records, while the columns field defines the structure and names of these nested data, enabling a complete representation of hierarchical data.

Required Systemrole

R_WFADM_START (ID = 20)

Request
Method

GET

Request Query Parameter

  • isComplete (boolean): If the isComplete flag is set to true, the returned variables correspond to a historical entry identified by its ID in the request path; otherwise, variables for the running task are returned. Default: false.

Response
Format

JSON

Minimum Version

1.0.0

Request
Example

/api/bpm/tasks/33AFD89453E248B4BC7CBF594D64BE36/variables

/api/bpm/tasks/33AFD89453E248B4BC7CBF594D64BE36/variables?isComplete=true

Result
Example

{ "objects": [ { "id": "593DD944F35B43F1BB8889EC92C7B0F1", "name": "lVirtuelleRollen", "type": "list", "value": [ [ "E68A04C8054C4BEA9990995A4D629C7F", "E68A04C8054C4BEA9990995A4D629C7F", "908F03A5BA4646858D161C4160141108", "E68A04C8054C4BEA9990995A4D629C7F", 0, "908F03A5BA4646858D161C4160141108", "Initialization" ] ], "columns": [ { "type": "record", "columns": [ { "name": "VorherigeBearbeiter", "type": "string" }, { "name": "VorherigeEmpfaenger", "type": "string" }, { "name": "ErsteBearbeiter", "type": "string" }, { "name": "ErsteEmpfaenger", "type": "string" }, { "name": "Anzahl", "type": "integer" }, { "name": "AktivitaetId", "type": "string" }, { "name": "AktivitaetName", "type": "string" } ] } ] }, { "id": "24266FE492024882940A14BFF47F0A02", "name": "daStartdatum", "type": "datetime", "value": "2025-04-08T08:41:02+02:00" } ], "numItems": 2, "hasMoreItems": false, "totalNumItems": 2 }