/
[GET] /objects/{objectId}/processes

[GET] /objects/{objectId}/processes

/api/bpm/dms/objects/{objectId}/processes

Description

To retrieve list of processes that contain a specific object, represented by objectId, in their files.

Request
Method

GET

Request Optional Query Parameters

  • organizationId (String): The id of the organization where the processes are located. If not sent, active organization is used.

  • includeCompleted (boolean): If true, then completed processes are determined as well. Otherwise, only running processes are returned. Default: false.

Response
Format

JSON

Minimum Version

1.3.0

Request
Example

/api/bpm/dms/objects/4156/processes?organizationId=8C2CC574556E40298E636278ECA20D7E&includeCompleted=true

Result
Example

{ "objects": [{ "id": "E0E8AF5991A5401E81DA65AD43D1AC24", "name": "Standard-Ad-hoc-Workflow 89", "startTime": "2022-05-13T09:27:05", "startUserId": "E68A04C8054C4BEA9990995A4D629C7F", "startUserName": "ROOT", "processSubject": "mj1234", "state": "running", "lastTask": { "id": "908F03A5BA4646858D161C4160141108", "name": "Initialisierung", "endTime": "2022-05-13T09:28:18" } },{ "id": "74472B0A1F224257B318801CBAD57392", "name": "Standard-Ad-hoc-Workflow 2", "startTime": "2022-11-24T11:28:06", "startUserId": "B1B5246AA8D64B3D815B68E95AB10E9C", "startUserName": "SCHMEISSEL", "processSubject": "asdf", "state": "finished", "lastTask": { "id": "00000000000000000000000000000000", "name": "StartActivity", "endTime": "2022-11-24T11:28:07" } }], "numItems": 2, "hasMoreItems": false, "totalNumItems": 2 }

Response codes

  • 200 - Success: The processes containing the specified object have been successfully returned.

  • 404 - Not found: The requested object was not found.

  • 403 - If the user does not have permission to read the object.